1 // SPDX-License-Identifier: GPL-2.0
3 * NVMe over Fabrics TCP host.
4 * Copyright (c) 2018 Lightbits Labs. All rights reserved.
6 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
7 #include <linux/module.h>
8 #include <linux/init.h>
9 #include <linux/slab.h>
10 #include <linux/err.h>
11 #include <linux/nvme-tcp.h>
14 #include <linux/blk-mq.h>
15 #include <crypto/hash.h>
20 struct nvme_tcp_queue;
22 enum nvme_tcp_send_state {
23 NVME_TCP_SEND_CMD_PDU = 0,
24 NVME_TCP_SEND_H2C_PDU,
29 struct nvme_tcp_request {
30 struct nvme_request req;
32 struct nvme_tcp_queue *queue;
37 struct list_head entry;
46 enum nvme_tcp_send_state state;
49 enum nvme_tcp_queue_flags {
50 NVME_TCP_Q_ALLOCATED = 0,
54 enum nvme_tcp_recv_state {
55 NVME_TCP_RECV_PDU = 0,
61 struct nvme_tcp_queue {
63 struct work_struct io_work;
67 struct list_head send_list;
73 size_t data_remaining;
74 size_t ddgst_remaining;
77 struct nvme_tcp_request *request;
80 size_t cmnd_capsule_len;
81 struct nvme_tcp_ctrl *ctrl;
87 struct ahash_request *rcv_hash;
88 struct ahash_request *snd_hash;
92 struct page_frag_cache pf_cache;
94 void (*state_change)(struct sock *);
95 void (*data_ready)(struct sock *);
96 void (*write_space)(struct sock *);
99 struct nvme_tcp_ctrl {
100 /* read only in the hot path */
101 struct nvme_tcp_queue *queues;
102 struct blk_mq_tag_set tag_set;
104 /* other member variables */
105 struct list_head list;
106 struct blk_mq_tag_set admin_tag_set;
107 struct sockaddr_storage addr;
108 struct sockaddr_storage src_addr;
109 struct nvme_ctrl ctrl;
111 struct work_struct err_work;
112 struct delayed_work connect_work;
113 struct nvme_tcp_request async_req;
116 static LIST_HEAD(nvme_tcp_ctrl_list);
117 static DEFINE_MUTEX(nvme_tcp_ctrl_mutex);
118 static struct workqueue_struct *nvme_tcp_wq;
119 static struct blk_mq_ops nvme_tcp_mq_ops;
120 static struct blk_mq_ops nvme_tcp_admin_mq_ops;
122 static inline struct nvme_tcp_ctrl *to_tcp_ctrl(struct nvme_ctrl *ctrl)
124 return container_of(ctrl, struct nvme_tcp_ctrl, ctrl);
127 static inline int nvme_tcp_queue_id(struct nvme_tcp_queue *queue)
129 return queue - queue->ctrl->queues;
132 static inline struct blk_mq_tags *nvme_tcp_tagset(struct nvme_tcp_queue *queue)
134 u32 queue_idx = nvme_tcp_queue_id(queue);
137 return queue->ctrl->admin_tag_set.tags[queue_idx];
138 return queue->ctrl->tag_set.tags[queue_idx - 1];
141 static inline u8 nvme_tcp_hdgst_len(struct nvme_tcp_queue *queue)
143 return queue->hdr_digest ? NVME_TCP_DIGEST_LENGTH : 0;
146 static inline u8 nvme_tcp_ddgst_len(struct nvme_tcp_queue *queue)
148 return queue->data_digest ? NVME_TCP_DIGEST_LENGTH : 0;
151 static inline size_t nvme_tcp_inline_data_size(struct nvme_tcp_queue *queue)
153 return queue->cmnd_capsule_len - sizeof(struct nvme_command);
156 static inline bool nvme_tcp_async_req(struct nvme_tcp_request *req)
158 return req == &req->queue->ctrl->async_req;
161 static inline bool nvme_tcp_has_inline_data(struct nvme_tcp_request *req)
166 if (unlikely(nvme_tcp_async_req(req)))
167 return false; /* async events don't have a request */
169 rq = blk_mq_rq_from_pdu(req);
170 bytes = blk_rq_payload_bytes(rq);
172 return rq_data_dir(rq) == WRITE && bytes &&
173 bytes <= nvme_tcp_inline_data_size(req->queue);
176 static inline struct page *nvme_tcp_req_cur_page(struct nvme_tcp_request *req)
178 return req->iter.bvec->bv_page;
181 static inline size_t nvme_tcp_req_cur_offset(struct nvme_tcp_request *req)
183 return req->iter.bvec->bv_offset + req->iter.iov_offset;
186 static inline size_t nvme_tcp_req_cur_length(struct nvme_tcp_request *req)
188 return min_t(size_t, req->iter.bvec->bv_len - req->iter.iov_offset,
189 req->pdu_len - req->pdu_sent);
192 static inline size_t nvme_tcp_req_offset(struct nvme_tcp_request *req)
194 return req->iter.iov_offset;
197 static inline size_t nvme_tcp_pdu_data_left(struct nvme_tcp_request *req)
199 return rq_data_dir(blk_mq_rq_from_pdu(req)) == WRITE ?
200 req->pdu_len - req->pdu_sent : 0;
203 static inline size_t nvme_tcp_pdu_last_send(struct nvme_tcp_request *req,
206 return nvme_tcp_pdu_data_left(req) <= len;
209 static void nvme_tcp_init_iter(struct nvme_tcp_request *req,
212 struct request *rq = blk_mq_rq_from_pdu(req);
218 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD) {
219 vec = &rq->special_vec;
221 size = blk_rq_payload_bytes(rq);
224 struct bio *bio = req->curr_bio;
226 vec = __bvec_iter_bvec(bio->bi_io_vec, bio->bi_iter);
227 nsegs = bio_segments(bio);
228 size = bio->bi_iter.bi_size;
229 offset = bio->bi_iter.bi_bvec_done;
232 iov_iter_bvec(&req->iter, dir, vec, nsegs, size);
233 req->iter.iov_offset = offset;
236 static inline void nvme_tcp_advance_req(struct nvme_tcp_request *req,
239 req->data_sent += len;
240 req->pdu_sent += len;
241 iov_iter_advance(&req->iter, len);
242 if (!iov_iter_count(&req->iter) &&
243 req->data_sent < req->data_len) {
244 req->curr_bio = req->curr_bio->bi_next;
245 nvme_tcp_init_iter(req, WRITE);
249 static inline void nvme_tcp_queue_request(struct nvme_tcp_request *req)
251 struct nvme_tcp_queue *queue = req->queue;
253 spin_lock(&queue->lock);
254 list_add_tail(&req->entry, &queue->send_list);
255 spin_unlock(&queue->lock);
257 queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
260 static inline struct nvme_tcp_request *
261 nvme_tcp_fetch_request(struct nvme_tcp_queue *queue)
263 struct nvme_tcp_request *req;
265 spin_lock(&queue->lock);
266 req = list_first_entry_or_null(&queue->send_list,
267 struct nvme_tcp_request, entry);
269 list_del(&req->entry);
270 spin_unlock(&queue->lock);
275 static inline void nvme_tcp_ddgst_final(struct ahash_request *hash,
278 ahash_request_set_crypt(hash, NULL, (u8 *)dgst, 0);
279 crypto_ahash_final(hash);
282 static inline void nvme_tcp_ddgst_update(struct ahash_request *hash,
283 struct page *page, off_t off, size_t len)
285 struct scatterlist sg;
287 sg_init_marker(&sg, 1);
288 sg_set_page(&sg, page, len, off);
289 ahash_request_set_crypt(hash, &sg, NULL, len);
290 crypto_ahash_update(hash);
293 static inline void nvme_tcp_hdgst(struct ahash_request *hash,
294 void *pdu, size_t len)
296 struct scatterlist sg;
298 sg_init_one(&sg, pdu, len);
299 ahash_request_set_crypt(hash, &sg, pdu + len, len);
300 crypto_ahash_digest(hash);
303 static int nvme_tcp_verify_hdgst(struct nvme_tcp_queue *queue,
304 void *pdu, size_t pdu_len)
306 struct nvme_tcp_hdr *hdr = pdu;
310 if (unlikely(!(hdr->flags & NVME_TCP_F_HDGST))) {
311 dev_err(queue->ctrl->ctrl.device,
312 "queue %d: header digest flag is cleared\n",
313 nvme_tcp_queue_id(queue));
317 recv_digest = *(__le32 *)(pdu + hdr->hlen);
318 nvme_tcp_hdgst(queue->rcv_hash, pdu, pdu_len);
319 exp_digest = *(__le32 *)(pdu + hdr->hlen);
320 if (recv_digest != exp_digest) {
321 dev_err(queue->ctrl->ctrl.device,
322 "header digest error: recv %#x expected %#x\n",
323 le32_to_cpu(recv_digest), le32_to_cpu(exp_digest));
330 static int nvme_tcp_check_ddgst(struct nvme_tcp_queue *queue, void *pdu)
332 struct nvme_tcp_hdr *hdr = pdu;
333 u8 digest_len = nvme_tcp_hdgst_len(queue);
336 len = le32_to_cpu(hdr->plen) - hdr->hlen -
337 ((hdr->flags & NVME_TCP_F_HDGST) ? digest_len : 0);
339 if (unlikely(len && !(hdr->flags & NVME_TCP_F_DDGST))) {
340 dev_err(queue->ctrl->ctrl.device,
341 "queue %d: data digest flag is cleared\n",
342 nvme_tcp_queue_id(queue));
345 crypto_ahash_init(queue->rcv_hash);
350 static void nvme_tcp_exit_request(struct blk_mq_tag_set *set,
351 struct request *rq, unsigned int hctx_idx)
353 struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
355 page_frag_free(req->pdu);
358 static int nvme_tcp_init_request(struct blk_mq_tag_set *set,
359 struct request *rq, unsigned int hctx_idx,
360 unsigned int numa_node)
362 struct nvme_tcp_ctrl *ctrl = set->driver_data;
363 struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
364 int queue_idx = (set == &ctrl->tag_set) ? hctx_idx + 1 : 0;
365 struct nvme_tcp_queue *queue = &ctrl->queues[queue_idx];
366 u8 hdgst = nvme_tcp_hdgst_len(queue);
368 req->pdu = page_frag_alloc(&queue->pf_cache,
369 sizeof(struct nvme_tcp_cmd_pdu) + hdgst,
370 GFP_KERNEL | __GFP_ZERO);
375 nvme_req(rq)->ctrl = &ctrl->ctrl;
380 static int nvme_tcp_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
381 unsigned int hctx_idx)
383 struct nvme_tcp_ctrl *ctrl = data;
384 struct nvme_tcp_queue *queue = &ctrl->queues[hctx_idx + 1];
386 hctx->driver_data = queue;
390 static int nvme_tcp_init_admin_hctx(struct blk_mq_hw_ctx *hctx, void *data,
391 unsigned int hctx_idx)
393 struct nvme_tcp_ctrl *ctrl = data;
394 struct nvme_tcp_queue *queue = &ctrl->queues[0];
396 hctx->driver_data = queue;
400 static enum nvme_tcp_recv_state
401 nvme_tcp_recv_state(struct nvme_tcp_queue *queue)
403 return (queue->pdu_remaining) ? NVME_TCP_RECV_PDU :
404 (queue->ddgst_remaining) ? NVME_TCP_RECV_DDGST :
408 static void nvme_tcp_init_recv_ctx(struct nvme_tcp_queue *queue)
410 queue->pdu_remaining = sizeof(struct nvme_tcp_rsp_pdu) +
411 nvme_tcp_hdgst_len(queue);
412 queue->pdu_offset = 0;
413 queue->data_remaining = -1;
414 queue->ddgst_remaining = 0;
417 static void nvme_tcp_error_recovery(struct nvme_ctrl *ctrl)
419 if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING))
422 queue_work(nvme_wq, &to_tcp_ctrl(ctrl)->err_work);
425 static int nvme_tcp_process_nvme_cqe(struct nvme_tcp_queue *queue,
426 struct nvme_completion *cqe)
430 rq = blk_mq_tag_to_rq(nvme_tcp_tagset(queue), cqe->command_id);
432 dev_err(queue->ctrl->ctrl.device,
433 "queue %d tag 0x%x not found\n",
434 nvme_tcp_queue_id(queue), cqe->command_id);
435 nvme_tcp_error_recovery(&queue->ctrl->ctrl);
439 nvme_end_request(rq, cqe->status, cqe->result);
444 static int nvme_tcp_handle_c2h_data(struct nvme_tcp_queue *queue,
445 struct nvme_tcp_data_pdu *pdu)
449 rq = blk_mq_tag_to_rq(nvme_tcp_tagset(queue), pdu->command_id);
451 dev_err(queue->ctrl->ctrl.device,
452 "queue %d tag %#x not found\n",
453 nvme_tcp_queue_id(queue), pdu->command_id);
457 if (!blk_rq_payload_bytes(rq)) {
458 dev_err(queue->ctrl->ctrl.device,
459 "queue %d tag %#x unexpected data\n",
460 nvme_tcp_queue_id(queue), rq->tag);
464 queue->data_remaining = le32_to_cpu(pdu->data_length);
466 if (pdu->hdr.flags & NVME_TCP_F_DATA_SUCCESS &&
467 unlikely(!(pdu->hdr.flags & NVME_TCP_F_DATA_LAST))) {
468 dev_err(queue->ctrl->ctrl.device,
469 "queue %d tag %#x SUCCESS set but not last PDU\n",
470 nvme_tcp_queue_id(queue), rq->tag);
471 nvme_tcp_error_recovery(&queue->ctrl->ctrl);
478 static int nvme_tcp_handle_comp(struct nvme_tcp_queue *queue,
479 struct nvme_tcp_rsp_pdu *pdu)
481 struct nvme_completion *cqe = &pdu->cqe;
485 * AEN requests are special as they don't time out and can
486 * survive any kind of queue freeze and often don't respond to
487 * aborts. We don't even bother to allocate a struct request
488 * for them but rather special case them here.
490 if (unlikely(nvme_tcp_queue_id(queue) == 0 &&
491 cqe->command_id >= NVME_AQ_BLK_MQ_DEPTH))
492 nvme_complete_async_event(&queue->ctrl->ctrl, cqe->status,
495 ret = nvme_tcp_process_nvme_cqe(queue, cqe);
500 static int nvme_tcp_setup_h2c_data_pdu(struct nvme_tcp_request *req,
501 struct nvme_tcp_r2t_pdu *pdu)
503 struct nvme_tcp_data_pdu *data = req->pdu;
504 struct nvme_tcp_queue *queue = req->queue;
505 struct request *rq = blk_mq_rq_from_pdu(req);
506 u8 hdgst = nvme_tcp_hdgst_len(queue);
507 u8 ddgst = nvme_tcp_ddgst_len(queue);
509 req->pdu_len = le32_to_cpu(pdu->r2t_length);
512 if (unlikely(req->data_sent + req->pdu_len > req->data_len)) {
513 dev_err(queue->ctrl->ctrl.device,
514 "req %d r2t len %u exceeded data len %u (%zu sent)\n",
515 rq->tag, req->pdu_len, req->data_len,
520 if (unlikely(le32_to_cpu(pdu->r2t_offset) < req->data_sent)) {
521 dev_err(queue->ctrl->ctrl.device,
522 "req %d unexpected r2t offset %u (expected %zu)\n",
523 rq->tag, le32_to_cpu(pdu->r2t_offset),
528 memset(data, 0, sizeof(*data));
529 data->hdr.type = nvme_tcp_h2c_data;
530 data->hdr.flags = NVME_TCP_F_DATA_LAST;
531 if (queue->hdr_digest)
532 data->hdr.flags |= NVME_TCP_F_HDGST;
533 if (queue->data_digest)
534 data->hdr.flags |= NVME_TCP_F_DDGST;
535 data->hdr.hlen = sizeof(*data);
536 data->hdr.pdo = data->hdr.hlen + hdgst;
538 cpu_to_le32(data->hdr.hlen + hdgst + req->pdu_len + ddgst);
539 data->ttag = pdu->ttag;
540 data->command_id = rq->tag;
541 data->data_offset = cpu_to_le32(req->data_sent);
542 data->data_length = cpu_to_le32(req->pdu_len);
546 static int nvme_tcp_handle_r2t(struct nvme_tcp_queue *queue,
547 struct nvme_tcp_r2t_pdu *pdu)
549 struct nvme_tcp_request *req;
553 rq = blk_mq_tag_to_rq(nvme_tcp_tagset(queue), pdu->command_id);
555 dev_err(queue->ctrl->ctrl.device,
556 "queue %d tag %#x not found\n",
557 nvme_tcp_queue_id(queue), pdu->command_id);
560 req = blk_mq_rq_to_pdu(rq);
562 ret = nvme_tcp_setup_h2c_data_pdu(req, pdu);
566 req->state = NVME_TCP_SEND_H2C_PDU;
569 nvme_tcp_queue_request(req);
574 static int nvme_tcp_recv_pdu(struct nvme_tcp_queue *queue, struct sk_buff *skb,
575 unsigned int *offset, size_t *len)
577 struct nvme_tcp_hdr *hdr;
578 char *pdu = queue->pdu;
579 size_t rcv_len = min_t(size_t, *len, queue->pdu_remaining);
582 ret = skb_copy_bits(skb, *offset,
583 &pdu[queue->pdu_offset], rcv_len);
587 queue->pdu_remaining -= rcv_len;
588 queue->pdu_offset += rcv_len;
591 if (queue->pdu_remaining)
595 if (queue->hdr_digest) {
596 ret = nvme_tcp_verify_hdgst(queue, queue->pdu, hdr->hlen);
602 if (queue->data_digest) {
603 ret = nvme_tcp_check_ddgst(queue, queue->pdu);
609 case nvme_tcp_c2h_data:
610 ret = nvme_tcp_handle_c2h_data(queue, (void *)queue->pdu);
613 nvme_tcp_init_recv_ctx(queue);
614 ret = nvme_tcp_handle_comp(queue, (void *)queue->pdu);
617 nvme_tcp_init_recv_ctx(queue);
618 ret = nvme_tcp_handle_r2t(queue, (void *)queue->pdu);
621 dev_err(queue->ctrl->ctrl.device,
622 "unsupported pdu type (%d)\n", hdr->type);
629 static inline void nvme_tcp_end_request(struct request *rq, u16 status)
631 union nvme_result res = {};
633 nvme_end_request(rq, cpu_to_le16(status << 1), res);
636 static int nvme_tcp_recv_data(struct nvme_tcp_queue *queue, struct sk_buff *skb,
637 unsigned int *offset, size_t *len)
639 struct nvme_tcp_data_pdu *pdu = (void *)queue->pdu;
640 struct nvme_tcp_request *req;
643 rq = blk_mq_tag_to_rq(nvme_tcp_tagset(queue), pdu->command_id);
645 dev_err(queue->ctrl->ctrl.device,
646 "queue %d tag %#x not found\n",
647 nvme_tcp_queue_id(queue), pdu->command_id);
650 req = blk_mq_rq_to_pdu(rq);
655 recv_len = min_t(size_t, *len, queue->data_remaining);
659 if (!iov_iter_count(&req->iter)) {
660 req->curr_bio = req->curr_bio->bi_next;
663 * If we don`t have any bios it means that controller
664 * sent more data than we requested, hence error
666 if (!req->curr_bio) {
667 dev_err(queue->ctrl->ctrl.device,
668 "queue %d no space in request %#x",
669 nvme_tcp_queue_id(queue), rq->tag);
670 nvme_tcp_init_recv_ctx(queue);
673 nvme_tcp_init_iter(req, READ);
676 /* we can read only from what is left in this bio */
677 recv_len = min_t(size_t, recv_len,
678 iov_iter_count(&req->iter));
680 if (queue->data_digest)
681 ret = skb_copy_and_hash_datagram_iter(skb, *offset,
682 &req->iter, recv_len, queue->rcv_hash);
684 ret = skb_copy_datagram_iter(skb, *offset,
685 &req->iter, recv_len);
687 dev_err(queue->ctrl->ctrl.device,
688 "queue %d failed to copy request %#x data",
689 nvme_tcp_queue_id(queue), rq->tag);
695 queue->data_remaining -= recv_len;
698 if (!queue->data_remaining) {
699 if (queue->data_digest) {
700 nvme_tcp_ddgst_final(queue->rcv_hash, &queue->exp_ddgst);
701 queue->ddgst_remaining = NVME_TCP_DIGEST_LENGTH;
703 if (pdu->hdr.flags & NVME_TCP_F_DATA_SUCCESS)
704 nvme_tcp_end_request(rq, NVME_SC_SUCCESS);
705 nvme_tcp_init_recv_ctx(queue);
712 static int nvme_tcp_recv_ddgst(struct nvme_tcp_queue *queue,
713 struct sk_buff *skb, unsigned int *offset, size_t *len)
715 struct nvme_tcp_data_pdu *pdu = (void *)queue->pdu;
716 char *ddgst = (char *)&queue->recv_ddgst;
717 size_t recv_len = min_t(size_t, *len, queue->ddgst_remaining);
718 off_t off = NVME_TCP_DIGEST_LENGTH - queue->ddgst_remaining;
721 ret = skb_copy_bits(skb, *offset, &ddgst[off], recv_len);
725 queue->ddgst_remaining -= recv_len;
728 if (queue->ddgst_remaining)
731 if (queue->recv_ddgst != queue->exp_ddgst) {
732 dev_err(queue->ctrl->ctrl.device,
733 "data digest error: recv %#x expected %#x\n",
734 le32_to_cpu(queue->recv_ddgst),
735 le32_to_cpu(queue->exp_ddgst));
739 if (pdu->hdr.flags & NVME_TCP_F_DATA_SUCCESS) {
740 struct request *rq = blk_mq_tag_to_rq(nvme_tcp_tagset(queue),
743 nvme_tcp_end_request(rq, NVME_SC_SUCCESS);
746 nvme_tcp_init_recv_ctx(queue);
750 static int nvme_tcp_recv_skb(read_descriptor_t *desc, struct sk_buff *skb,
751 unsigned int offset, size_t len)
753 struct nvme_tcp_queue *queue = desc->arg.data;
754 size_t consumed = len;
758 switch (nvme_tcp_recv_state(queue)) {
759 case NVME_TCP_RECV_PDU:
760 result = nvme_tcp_recv_pdu(queue, skb, &offset, &len);
762 case NVME_TCP_RECV_DATA:
763 result = nvme_tcp_recv_data(queue, skb, &offset, &len);
765 case NVME_TCP_RECV_DDGST:
766 result = nvme_tcp_recv_ddgst(queue, skb, &offset, &len);
772 dev_err(queue->ctrl->ctrl.device,
773 "receive failed: %d\n", result);
774 queue->rd_enabled = false;
775 nvme_tcp_error_recovery(&queue->ctrl->ctrl);
783 static void nvme_tcp_data_ready(struct sock *sk)
785 struct nvme_tcp_queue *queue;
787 read_lock(&sk->sk_callback_lock);
788 queue = sk->sk_user_data;
789 if (likely(queue && queue->rd_enabled))
790 queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
791 read_unlock(&sk->sk_callback_lock);
794 static void nvme_tcp_write_space(struct sock *sk)
796 struct nvme_tcp_queue *queue;
798 read_lock_bh(&sk->sk_callback_lock);
799 queue = sk->sk_user_data;
800 if (likely(queue && sk_stream_is_writeable(sk))) {
801 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
802 queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
804 read_unlock_bh(&sk->sk_callback_lock);
807 static void nvme_tcp_state_change(struct sock *sk)
809 struct nvme_tcp_queue *queue;
811 read_lock(&sk->sk_callback_lock);
812 queue = sk->sk_user_data;
816 switch (sk->sk_state) {
823 nvme_tcp_error_recovery(&queue->ctrl->ctrl);
826 dev_info(queue->ctrl->ctrl.device,
827 "queue %d socket state %d\n",
828 nvme_tcp_queue_id(queue), sk->sk_state);
831 queue->state_change(sk);
833 read_unlock(&sk->sk_callback_lock);
836 static inline void nvme_tcp_done_send_req(struct nvme_tcp_queue *queue)
838 queue->request = NULL;
841 static void nvme_tcp_fail_request(struct nvme_tcp_request *req)
843 nvme_tcp_end_request(blk_mq_rq_from_pdu(req), NVME_SC_DATA_XFER_ERROR);
846 static int nvme_tcp_try_send_data(struct nvme_tcp_request *req)
848 struct nvme_tcp_queue *queue = req->queue;
851 struct page *page = nvme_tcp_req_cur_page(req);
852 size_t offset = nvme_tcp_req_cur_offset(req);
853 size_t len = nvme_tcp_req_cur_length(req);
854 bool last = nvme_tcp_pdu_last_send(req, len);
855 int ret, flags = MSG_DONTWAIT;
857 if (last && !queue->data_digest)
862 ret = kernel_sendpage(queue->sock, page, offset, len, flags);
866 nvme_tcp_advance_req(req, ret);
867 if (queue->data_digest)
868 nvme_tcp_ddgst_update(queue->snd_hash, page,
871 /* fully successful last write*/
872 if (last && ret == len) {
873 if (queue->data_digest) {
874 nvme_tcp_ddgst_final(queue->snd_hash,
876 req->state = NVME_TCP_SEND_DDGST;
879 nvme_tcp_done_send_req(queue);
887 static int nvme_tcp_try_send_cmd_pdu(struct nvme_tcp_request *req)
889 struct nvme_tcp_queue *queue = req->queue;
890 struct nvme_tcp_cmd_pdu *pdu = req->pdu;
891 bool inline_data = nvme_tcp_has_inline_data(req);
892 int flags = MSG_DONTWAIT | (inline_data ? MSG_MORE : MSG_EOR);
893 u8 hdgst = nvme_tcp_hdgst_len(queue);
894 int len = sizeof(*pdu) + hdgst - req->offset;
897 if (queue->hdr_digest && !req->offset)
898 nvme_tcp_hdgst(queue->snd_hash, pdu, sizeof(*pdu));
900 ret = kernel_sendpage(queue->sock, virt_to_page(pdu),
901 offset_in_page(pdu) + req->offset, len, flags);
902 if (unlikely(ret <= 0))
908 req->state = NVME_TCP_SEND_DATA;
909 if (queue->data_digest)
910 crypto_ahash_init(queue->snd_hash);
911 nvme_tcp_init_iter(req, WRITE);
913 nvme_tcp_done_send_req(queue);
922 static int nvme_tcp_try_send_data_pdu(struct nvme_tcp_request *req)
924 struct nvme_tcp_queue *queue = req->queue;
925 struct nvme_tcp_data_pdu *pdu = req->pdu;
926 u8 hdgst = nvme_tcp_hdgst_len(queue);
927 int len = sizeof(*pdu) - req->offset + hdgst;
930 if (queue->hdr_digest && !req->offset)
931 nvme_tcp_hdgst(queue->snd_hash, pdu, sizeof(*pdu));
933 ret = kernel_sendpage(queue->sock, virt_to_page(pdu),
934 offset_in_page(pdu) + req->offset, len,
935 MSG_DONTWAIT | MSG_MORE);
936 if (unlikely(ret <= 0))
941 req->state = NVME_TCP_SEND_DATA;
942 if (queue->data_digest)
943 crypto_ahash_init(queue->snd_hash);
945 nvme_tcp_init_iter(req, WRITE);
953 static int nvme_tcp_try_send_ddgst(struct nvme_tcp_request *req)
955 struct nvme_tcp_queue *queue = req->queue;
957 struct msghdr msg = { .msg_flags = MSG_DONTWAIT | MSG_EOR };
959 .iov_base = &req->ddgst + req->offset,
960 .iov_len = NVME_TCP_DIGEST_LENGTH - req->offset
963 ret = kernel_sendmsg(queue->sock, &msg, &iov, 1, iov.iov_len);
964 if (unlikely(ret <= 0))
967 if (req->offset + ret == NVME_TCP_DIGEST_LENGTH) {
968 nvme_tcp_done_send_req(queue);
976 static int nvme_tcp_try_send(struct nvme_tcp_queue *queue)
978 struct nvme_tcp_request *req;
981 if (!queue->request) {
982 queue->request = nvme_tcp_fetch_request(queue);
986 req = queue->request;
988 if (req->state == NVME_TCP_SEND_CMD_PDU) {
989 ret = nvme_tcp_try_send_cmd_pdu(req);
992 if (!nvme_tcp_has_inline_data(req))
996 if (req->state == NVME_TCP_SEND_H2C_PDU) {
997 ret = nvme_tcp_try_send_data_pdu(req);
1002 if (req->state == NVME_TCP_SEND_DATA) {
1003 ret = nvme_tcp_try_send_data(req);
1008 if (req->state == NVME_TCP_SEND_DDGST)
1009 ret = nvme_tcp_try_send_ddgst(req);
1016 static int nvme_tcp_try_recv(struct nvme_tcp_queue *queue)
1018 struct sock *sk = queue->sock->sk;
1019 read_descriptor_t rd_desc;
1022 rd_desc.arg.data = queue;
1025 consumed = tcp_read_sock(sk, &rd_desc, nvme_tcp_recv_skb);
1030 static void nvme_tcp_io_work(struct work_struct *w)
1032 struct nvme_tcp_queue *queue =
1033 container_of(w, struct nvme_tcp_queue, io_work);
1034 unsigned long start = jiffies + msecs_to_jiffies(1);
1037 bool pending = false;
1040 result = nvme_tcp_try_send(queue);
1043 } else if (unlikely(result < 0)) {
1044 dev_err(queue->ctrl->ctrl.device,
1045 "failed to send request %d\n", result);
1046 if (result != -EPIPE)
1047 nvme_tcp_fail_request(queue->request);
1048 nvme_tcp_done_send_req(queue);
1052 result = nvme_tcp_try_recv(queue);
1059 } while (time_after(jiffies, start)); /* quota is exhausted */
1061 queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
1064 static void nvme_tcp_free_crypto(struct nvme_tcp_queue *queue)
1066 struct crypto_ahash *tfm = crypto_ahash_reqtfm(queue->rcv_hash);
1068 ahash_request_free(queue->rcv_hash);
1069 ahash_request_free(queue->snd_hash);
1070 crypto_free_ahash(tfm);
1073 static int nvme_tcp_alloc_crypto(struct nvme_tcp_queue *queue)
1075 struct crypto_ahash *tfm;
1077 tfm = crypto_alloc_ahash("crc32c", 0, CRYPTO_ALG_ASYNC);
1079 return PTR_ERR(tfm);
1081 queue->snd_hash = ahash_request_alloc(tfm, GFP_KERNEL);
1082 if (!queue->snd_hash)
1084 ahash_request_set_callback(queue->snd_hash, 0, NULL, NULL);
1086 queue->rcv_hash = ahash_request_alloc(tfm, GFP_KERNEL);
1087 if (!queue->rcv_hash)
1089 ahash_request_set_callback(queue->rcv_hash, 0, NULL, NULL);
1093 ahash_request_free(queue->snd_hash);
1095 crypto_free_ahash(tfm);
1099 static void nvme_tcp_free_async_req(struct nvme_tcp_ctrl *ctrl)
1101 struct nvme_tcp_request *async = &ctrl->async_req;
1103 page_frag_free(async->pdu);
1106 static int nvme_tcp_alloc_async_req(struct nvme_tcp_ctrl *ctrl)
1108 struct nvme_tcp_queue *queue = &ctrl->queues[0];
1109 struct nvme_tcp_request *async = &ctrl->async_req;
1110 u8 hdgst = nvme_tcp_hdgst_len(queue);
1112 async->pdu = page_frag_alloc(&queue->pf_cache,
1113 sizeof(struct nvme_tcp_cmd_pdu) + hdgst,
1114 GFP_KERNEL | __GFP_ZERO);
1118 async->queue = &ctrl->queues[0];
1122 static void nvme_tcp_free_queue(struct nvme_ctrl *nctrl, int qid)
1124 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1125 struct nvme_tcp_queue *queue = &ctrl->queues[qid];
1127 if (!test_and_clear_bit(NVME_TCP_Q_ALLOCATED, &queue->flags))
1130 if (queue->hdr_digest || queue->data_digest)
1131 nvme_tcp_free_crypto(queue);
1133 sock_release(queue->sock);
1137 static int nvme_tcp_init_connection(struct nvme_tcp_queue *queue)
1139 struct nvme_tcp_icreq_pdu *icreq;
1140 struct nvme_tcp_icresp_pdu *icresp;
1141 struct msghdr msg = {};
1143 bool ctrl_hdgst, ctrl_ddgst;
1146 icreq = kzalloc(sizeof(*icreq), GFP_KERNEL);
1150 icresp = kzalloc(sizeof(*icresp), GFP_KERNEL);
1156 icreq->hdr.type = nvme_tcp_icreq;
1157 icreq->hdr.hlen = sizeof(*icreq);
1159 icreq->hdr.plen = cpu_to_le32(icreq->hdr.hlen);
1160 icreq->pfv = cpu_to_le16(NVME_TCP_PFV_1_0);
1161 icreq->maxr2t = 0; /* single inflight r2t supported */
1162 icreq->hpda = 0; /* no alignment constraint */
1163 if (queue->hdr_digest)
1164 icreq->digest |= NVME_TCP_HDR_DIGEST_ENABLE;
1165 if (queue->data_digest)
1166 icreq->digest |= NVME_TCP_DATA_DIGEST_ENABLE;
1168 iov.iov_base = icreq;
1169 iov.iov_len = sizeof(*icreq);
1170 ret = kernel_sendmsg(queue->sock, &msg, &iov, 1, iov.iov_len);
1174 memset(&msg, 0, sizeof(msg));
1175 iov.iov_base = icresp;
1176 iov.iov_len = sizeof(*icresp);
1177 ret = kernel_recvmsg(queue->sock, &msg, &iov, 1,
1178 iov.iov_len, msg.msg_flags);
1183 if (icresp->hdr.type != nvme_tcp_icresp) {
1184 pr_err("queue %d: bad type returned %d\n",
1185 nvme_tcp_queue_id(queue), icresp->hdr.type);
1189 if (le32_to_cpu(icresp->hdr.plen) != sizeof(*icresp)) {
1190 pr_err("queue %d: bad pdu length returned %d\n",
1191 nvme_tcp_queue_id(queue), icresp->hdr.plen);
1195 if (icresp->pfv != NVME_TCP_PFV_1_0) {
1196 pr_err("queue %d: bad pfv returned %d\n",
1197 nvme_tcp_queue_id(queue), icresp->pfv);
1201 ctrl_ddgst = !!(icresp->digest & NVME_TCP_DATA_DIGEST_ENABLE);
1202 if ((queue->data_digest && !ctrl_ddgst) ||
1203 (!queue->data_digest && ctrl_ddgst)) {
1204 pr_err("queue %d: data digest mismatch host: %s ctrl: %s\n",
1205 nvme_tcp_queue_id(queue),
1206 queue->data_digest ? "enabled" : "disabled",
1207 ctrl_ddgst ? "enabled" : "disabled");
1211 ctrl_hdgst = !!(icresp->digest & NVME_TCP_HDR_DIGEST_ENABLE);
1212 if ((queue->hdr_digest && !ctrl_hdgst) ||
1213 (!queue->hdr_digest && ctrl_hdgst)) {
1214 pr_err("queue %d: header digest mismatch host: %s ctrl: %s\n",
1215 nvme_tcp_queue_id(queue),
1216 queue->hdr_digest ? "enabled" : "disabled",
1217 ctrl_hdgst ? "enabled" : "disabled");
1221 if (icresp->cpda != 0) {
1222 pr_err("queue %d: unsupported cpda returned %d\n",
1223 nvme_tcp_queue_id(queue), icresp->cpda);
1235 static int nvme_tcp_alloc_queue(struct nvme_ctrl *nctrl,
1236 int qid, size_t queue_size)
1238 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1239 struct nvme_tcp_queue *queue = &ctrl->queues[qid];
1240 struct linger sol = { .l_onoff = 1, .l_linger = 0 };
1241 int ret, opt, rcv_pdu_size, n;
1244 INIT_LIST_HEAD(&queue->send_list);
1245 spin_lock_init(&queue->lock);
1246 INIT_WORK(&queue->io_work, nvme_tcp_io_work);
1247 queue->queue_size = queue_size;
1250 queue->cmnd_capsule_len = ctrl->ctrl.ioccsz * 16;
1252 queue->cmnd_capsule_len = sizeof(struct nvme_command) +
1253 NVME_TCP_ADMIN_CCSZ;
1255 ret = sock_create(ctrl->addr.ss_family, SOCK_STREAM,
1256 IPPROTO_TCP, &queue->sock);
1258 dev_err(ctrl->ctrl.device,
1259 "failed to create socket: %d\n", ret);
1263 /* Single syn retry */
1265 ret = kernel_setsockopt(queue->sock, IPPROTO_TCP, TCP_SYNCNT,
1266 (char *)&opt, sizeof(opt));
1268 dev_err(ctrl->ctrl.device,
1269 "failed to set TCP_SYNCNT sock opt %d\n", ret);
1273 /* Set TCP no delay */
1275 ret = kernel_setsockopt(queue->sock, IPPROTO_TCP,
1276 TCP_NODELAY, (char *)&opt, sizeof(opt));
1278 dev_err(ctrl->ctrl.device,
1279 "failed to set TCP_NODELAY sock opt %d\n", ret);
1284 * Cleanup whatever is sitting in the TCP transmit queue on socket
1285 * close. This is done to prevent stale data from being sent should
1286 * the network connection be restored before TCP times out.
1288 ret = kernel_setsockopt(queue->sock, SOL_SOCKET, SO_LINGER,
1289 (char *)&sol, sizeof(sol));
1291 dev_err(ctrl->ctrl.device,
1292 "failed to set SO_LINGER sock opt %d\n", ret);
1296 queue->sock->sk->sk_allocation = GFP_ATOMIC;
1300 n = (qid - 1) % num_online_cpus();
1301 queue->io_cpu = cpumask_next_wrap(n - 1, cpu_online_mask, -1, false);
1302 queue->request = NULL;
1303 queue->data_remaining = 0;
1304 queue->ddgst_remaining = 0;
1305 queue->pdu_remaining = 0;
1306 queue->pdu_offset = 0;
1307 sk_set_memalloc(queue->sock->sk);
1309 if (ctrl->ctrl.opts->mask & NVMF_OPT_HOST_TRADDR) {
1310 ret = kernel_bind(queue->sock, (struct sockaddr *)&ctrl->src_addr,
1311 sizeof(ctrl->src_addr));
1313 dev_err(ctrl->ctrl.device,
1314 "failed to bind queue %d socket %d\n",
1320 queue->hdr_digest = nctrl->opts->hdr_digest;
1321 queue->data_digest = nctrl->opts->data_digest;
1322 if (queue->hdr_digest || queue->data_digest) {
1323 ret = nvme_tcp_alloc_crypto(queue);
1325 dev_err(ctrl->ctrl.device,
1326 "failed to allocate queue %d crypto\n", qid);
1331 rcv_pdu_size = sizeof(struct nvme_tcp_rsp_pdu) +
1332 nvme_tcp_hdgst_len(queue);
1333 queue->pdu = kmalloc(rcv_pdu_size, GFP_KERNEL);
1339 dev_dbg(ctrl->ctrl.device, "connecting queue %d\n",
1340 nvme_tcp_queue_id(queue));
1342 ret = kernel_connect(queue->sock, (struct sockaddr *)&ctrl->addr,
1343 sizeof(ctrl->addr), 0);
1345 dev_err(ctrl->ctrl.device,
1346 "failed to connect socket: %d\n", ret);
1350 ret = nvme_tcp_init_connection(queue);
1352 goto err_init_connect;
1354 queue->rd_enabled = true;
1355 set_bit(NVME_TCP_Q_ALLOCATED, &queue->flags);
1356 nvme_tcp_init_recv_ctx(queue);
1358 write_lock_bh(&queue->sock->sk->sk_callback_lock);
1359 queue->sock->sk->sk_user_data = queue;
1360 queue->state_change = queue->sock->sk->sk_state_change;
1361 queue->data_ready = queue->sock->sk->sk_data_ready;
1362 queue->write_space = queue->sock->sk->sk_write_space;
1363 queue->sock->sk->sk_data_ready = nvme_tcp_data_ready;
1364 queue->sock->sk->sk_state_change = nvme_tcp_state_change;
1365 queue->sock->sk->sk_write_space = nvme_tcp_write_space;
1366 write_unlock_bh(&queue->sock->sk->sk_callback_lock);
1371 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
1375 if (queue->hdr_digest || queue->data_digest)
1376 nvme_tcp_free_crypto(queue);
1378 sock_release(queue->sock);
1383 static void nvme_tcp_restore_sock_calls(struct nvme_tcp_queue *queue)
1385 struct socket *sock = queue->sock;
1387 write_lock_bh(&sock->sk->sk_callback_lock);
1388 sock->sk->sk_user_data = NULL;
1389 sock->sk->sk_data_ready = queue->data_ready;
1390 sock->sk->sk_state_change = queue->state_change;
1391 sock->sk->sk_write_space = queue->write_space;
1392 write_unlock_bh(&sock->sk->sk_callback_lock);
1395 static void __nvme_tcp_stop_queue(struct nvme_tcp_queue *queue)
1397 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
1398 nvme_tcp_restore_sock_calls(queue);
1399 cancel_work_sync(&queue->io_work);
1402 static void nvme_tcp_stop_queue(struct nvme_ctrl *nctrl, int qid)
1404 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1405 struct nvme_tcp_queue *queue = &ctrl->queues[qid];
1407 if (!test_and_clear_bit(NVME_TCP_Q_LIVE, &queue->flags))
1410 __nvme_tcp_stop_queue(queue);
1413 static int nvme_tcp_start_queue(struct nvme_ctrl *nctrl, int idx)
1415 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1419 ret = nvmf_connect_io_queue(nctrl, idx, false);
1421 ret = nvmf_connect_admin_queue(nctrl);
1424 set_bit(NVME_TCP_Q_LIVE, &ctrl->queues[idx].flags);
1426 __nvme_tcp_stop_queue(&ctrl->queues[idx]);
1427 dev_err(nctrl->device,
1428 "failed to connect queue: %d ret=%d\n", idx, ret);
1433 static struct blk_mq_tag_set *nvme_tcp_alloc_tagset(struct nvme_ctrl *nctrl,
1436 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1437 struct blk_mq_tag_set *set;
1441 set = &ctrl->admin_tag_set;
1442 memset(set, 0, sizeof(*set));
1443 set->ops = &nvme_tcp_admin_mq_ops;
1444 set->queue_depth = NVME_AQ_MQ_TAG_DEPTH;
1445 set->reserved_tags = 2; /* connect + keep-alive */
1446 set->numa_node = NUMA_NO_NODE;
1447 set->cmd_size = sizeof(struct nvme_tcp_request);
1448 set->driver_data = ctrl;
1449 set->nr_hw_queues = 1;
1450 set->timeout = ADMIN_TIMEOUT;
1452 set = &ctrl->tag_set;
1453 memset(set, 0, sizeof(*set));
1454 set->ops = &nvme_tcp_mq_ops;
1455 set->queue_depth = nctrl->sqsize + 1;
1456 set->reserved_tags = 1; /* fabric connect */
1457 set->numa_node = NUMA_NO_NODE;
1458 set->flags = BLK_MQ_F_SHOULD_MERGE;
1459 set->cmd_size = sizeof(struct nvme_tcp_request);
1460 set->driver_data = ctrl;
1461 set->nr_hw_queues = nctrl->queue_count - 1;
1462 set->timeout = NVME_IO_TIMEOUT;
1463 set->nr_maps = 2 /* default + read */;
1466 ret = blk_mq_alloc_tag_set(set);
1468 return ERR_PTR(ret);
1473 static void nvme_tcp_free_admin_queue(struct nvme_ctrl *ctrl)
1475 if (to_tcp_ctrl(ctrl)->async_req.pdu) {
1476 nvme_tcp_free_async_req(to_tcp_ctrl(ctrl));
1477 to_tcp_ctrl(ctrl)->async_req.pdu = NULL;
1480 nvme_tcp_free_queue(ctrl, 0);
1483 static void nvme_tcp_free_io_queues(struct nvme_ctrl *ctrl)
1487 for (i = 1; i < ctrl->queue_count; i++)
1488 nvme_tcp_free_queue(ctrl, i);
1491 static void nvme_tcp_stop_io_queues(struct nvme_ctrl *ctrl)
1495 for (i = 1; i < ctrl->queue_count; i++)
1496 nvme_tcp_stop_queue(ctrl, i);
1499 static int nvme_tcp_start_io_queues(struct nvme_ctrl *ctrl)
1503 for (i = 1; i < ctrl->queue_count; i++) {
1504 ret = nvme_tcp_start_queue(ctrl, i);
1506 goto out_stop_queues;
1512 for (i--; i >= 1; i--)
1513 nvme_tcp_stop_queue(ctrl, i);
1517 static int nvme_tcp_alloc_admin_queue(struct nvme_ctrl *ctrl)
1521 ret = nvme_tcp_alloc_queue(ctrl, 0, NVME_AQ_DEPTH);
1525 ret = nvme_tcp_alloc_async_req(to_tcp_ctrl(ctrl));
1527 goto out_free_queue;
1532 nvme_tcp_free_queue(ctrl, 0);
1536 static int __nvme_tcp_alloc_io_queues(struct nvme_ctrl *ctrl)
1540 for (i = 1; i < ctrl->queue_count; i++) {
1541 ret = nvme_tcp_alloc_queue(ctrl, i,
1544 goto out_free_queues;
1550 for (i--; i >= 1; i--)
1551 nvme_tcp_free_queue(ctrl, i);
1556 static unsigned int nvme_tcp_nr_io_queues(struct nvme_ctrl *ctrl)
1558 unsigned int nr_io_queues;
1560 nr_io_queues = min(ctrl->opts->nr_io_queues, num_online_cpus());
1561 nr_io_queues += min(ctrl->opts->nr_write_queues, num_online_cpus());
1563 return nr_io_queues;
1566 static int nvme_tcp_alloc_io_queues(struct nvme_ctrl *ctrl)
1568 unsigned int nr_io_queues;
1571 nr_io_queues = nvme_tcp_nr_io_queues(ctrl);
1572 ret = nvme_set_queue_count(ctrl, &nr_io_queues);
1576 ctrl->queue_count = nr_io_queues + 1;
1577 if (ctrl->queue_count < 2)
1580 dev_info(ctrl->device,
1581 "creating %d I/O queues.\n", nr_io_queues);
1583 return __nvme_tcp_alloc_io_queues(ctrl);
1586 static void nvme_tcp_destroy_io_queues(struct nvme_ctrl *ctrl, bool remove)
1588 nvme_tcp_stop_io_queues(ctrl);
1590 blk_cleanup_queue(ctrl->connect_q);
1591 blk_mq_free_tag_set(ctrl->tagset);
1593 nvme_tcp_free_io_queues(ctrl);
1596 static int nvme_tcp_configure_io_queues(struct nvme_ctrl *ctrl, bool new)
1600 ret = nvme_tcp_alloc_io_queues(ctrl);
1605 ctrl->tagset = nvme_tcp_alloc_tagset(ctrl, false);
1606 if (IS_ERR(ctrl->tagset)) {
1607 ret = PTR_ERR(ctrl->tagset);
1608 goto out_free_io_queues;
1611 ctrl->connect_q = blk_mq_init_queue(ctrl->tagset);
1612 if (IS_ERR(ctrl->connect_q)) {
1613 ret = PTR_ERR(ctrl->connect_q);
1614 goto out_free_tag_set;
1617 blk_mq_update_nr_hw_queues(ctrl->tagset,
1618 ctrl->queue_count - 1);
1621 ret = nvme_tcp_start_io_queues(ctrl);
1623 goto out_cleanup_connect_q;
1627 out_cleanup_connect_q:
1629 blk_cleanup_queue(ctrl->connect_q);
1632 blk_mq_free_tag_set(ctrl->tagset);
1634 nvme_tcp_free_io_queues(ctrl);
1638 static void nvme_tcp_destroy_admin_queue(struct nvme_ctrl *ctrl, bool remove)
1640 nvme_tcp_stop_queue(ctrl, 0);
1642 blk_cleanup_queue(ctrl->admin_q);
1643 blk_mq_free_tag_set(ctrl->admin_tagset);
1645 nvme_tcp_free_admin_queue(ctrl);
1648 static int nvme_tcp_configure_admin_queue(struct nvme_ctrl *ctrl, bool new)
1652 error = nvme_tcp_alloc_admin_queue(ctrl);
1657 ctrl->admin_tagset = nvme_tcp_alloc_tagset(ctrl, true);
1658 if (IS_ERR(ctrl->admin_tagset)) {
1659 error = PTR_ERR(ctrl->admin_tagset);
1660 goto out_free_queue;
1663 ctrl->admin_q = blk_mq_init_queue(ctrl->admin_tagset);
1664 if (IS_ERR(ctrl->admin_q)) {
1665 error = PTR_ERR(ctrl->admin_q);
1666 goto out_free_tagset;
1670 error = nvme_tcp_start_queue(ctrl, 0);
1672 goto out_cleanup_queue;
1674 error = ctrl->ops->reg_read64(ctrl, NVME_REG_CAP, &ctrl->cap);
1676 dev_err(ctrl->device,
1677 "prop_get NVME_REG_CAP failed\n");
1678 goto out_stop_queue;
1681 ctrl->sqsize = min_t(int, NVME_CAP_MQES(ctrl->cap), ctrl->sqsize);
1683 error = nvme_enable_ctrl(ctrl, ctrl->cap);
1685 goto out_stop_queue;
1687 error = nvme_init_identify(ctrl);
1689 goto out_stop_queue;
1694 nvme_tcp_stop_queue(ctrl, 0);
1697 blk_cleanup_queue(ctrl->admin_q);
1700 blk_mq_free_tag_set(ctrl->admin_tagset);
1702 nvme_tcp_free_admin_queue(ctrl);
1706 static void nvme_tcp_teardown_admin_queue(struct nvme_ctrl *ctrl,
1709 blk_mq_quiesce_queue(ctrl->admin_q);
1710 nvme_tcp_stop_queue(ctrl, 0);
1711 if (ctrl->admin_tagset)
1712 blk_mq_tagset_busy_iter(ctrl->admin_tagset,
1713 nvme_cancel_request, ctrl);
1714 blk_mq_unquiesce_queue(ctrl->admin_q);
1715 nvme_tcp_destroy_admin_queue(ctrl, remove);
1718 static void nvme_tcp_teardown_io_queues(struct nvme_ctrl *ctrl,
1721 if (ctrl->queue_count <= 1)
1723 nvme_stop_queues(ctrl);
1724 nvme_tcp_stop_io_queues(ctrl);
1726 blk_mq_tagset_busy_iter(ctrl->tagset,
1727 nvme_cancel_request, ctrl);
1729 nvme_start_queues(ctrl);
1730 nvme_tcp_destroy_io_queues(ctrl, remove);
1733 static void nvme_tcp_reconnect_or_remove(struct nvme_ctrl *ctrl)
1735 /* If we are resetting/deleting then do nothing */
1736 if (ctrl->state != NVME_CTRL_CONNECTING) {
1737 WARN_ON_ONCE(ctrl->state == NVME_CTRL_NEW ||
1738 ctrl->state == NVME_CTRL_LIVE);
1742 if (nvmf_should_reconnect(ctrl)) {
1743 dev_info(ctrl->device, "Reconnecting in %d seconds...\n",
1744 ctrl->opts->reconnect_delay);
1745 queue_delayed_work(nvme_wq, &to_tcp_ctrl(ctrl)->connect_work,
1746 ctrl->opts->reconnect_delay * HZ);
1748 dev_info(ctrl->device, "Removing controller...\n");
1749 nvme_delete_ctrl(ctrl);
1753 static int nvme_tcp_setup_ctrl(struct nvme_ctrl *ctrl, bool new)
1755 struct nvmf_ctrl_options *opts = ctrl->opts;
1758 ret = nvme_tcp_configure_admin_queue(ctrl, new);
1763 dev_err(ctrl->device, "icdoff is not supported!\n");
1767 if (opts->queue_size > ctrl->sqsize + 1)
1768 dev_warn(ctrl->device,
1769 "queue_size %zu > ctrl sqsize %u, clamping down\n",
1770 opts->queue_size, ctrl->sqsize + 1);
1772 if (ctrl->sqsize + 1 > ctrl->maxcmd) {
1773 dev_warn(ctrl->device,
1774 "sqsize %u > ctrl maxcmd %u, clamping down\n",
1775 ctrl->sqsize + 1, ctrl->maxcmd);
1776 ctrl->sqsize = ctrl->maxcmd - 1;
1779 if (ctrl->queue_count > 1) {
1780 ret = nvme_tcp_configure_io_queues(ctrl, new);
1785 if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE)) {
1786 /* state change failure is ok if we're in DELETING state */
1787 WARN_ON_ONCE(ctrl->state != NVME_CTRL_DELETING);
1792 nvme_start_ctrl(ctrl);
1796 if (ctrl->queue_count > 1)
1797 nvme_tcp_destroy_io_queues(ctrl, new);
1799 nvme_tcp_stop_queue(ctrl, 0);
1800 nvme_tcp_destroy_admin_queue(ctrl, new);
1804 static void nvme_tcp_reconnect_ctrl_work(struct work_struct *work)
1806 struct nvme_tcp_ctrl *tcp_ctrl = container_of(to_delayed_work(work),
1807 struct nvme_tcp_ctrl, connect_work);
1808 struct nvme_ctrl *ctrl = &tcp_ctrl->ctrl;
1810 ++ctrl->nr_reconnects;
1812 if (nvme_tcp_setup_ctrl(ctrl, false))
1815 dev_info(ctrl->device, "Successfully reconnected (%d attempt)\n",
1816 ctrl->nr_reconnects);
1818 ctrl->nr_reconnects = 0;
1823 dev_info(ctrl->device, "Failed reconnect attempt %d\n",
1824 ctrl->nr_reconnects);
1825 nvme_tcp_reconnect_or_remove(ctrl);
1828 static void nvme_tcp_error_recovery_work(struct work_struct *work)
1830 struct nvme_tcp_ctrl *tcp_ctrl = container_of(work,
1831 struct nvme_tcp_ctrl, err_work);
1832 struct nvme_ctrl *ctrl = &tcp_ctrl->ctrl;
1834 nvme_stop_keep_alive(ctrl);
1835 nvme_tcp_teardown_io_queues(ctrl, false);
1836 /* unquiesce to fail fast pending requests */
1837 nvme_start_queues(ctrl);
1838 nvme_tcp_teardown_admin_queue(ctrl, false);
1840 if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_CONNECTING)) {
1841 /* state change failure is ok if we're in DELETING state */
1842 WARN_ON_ONCE(ctrl->state != NVME_CTRL_DELETING);
1846 nvme_tcp_reconnect_or_remove(ctrl);
1849 static void nvme_tcp_teardown_ctrl(struct nvme_ctrl *ctrl, bool shutdown)
1851 cancel_work_sync(&to_tcp_ctrl(ctrl)->err_work);
1852 cancel_delayed_work_sync(&to_tcp_ctrl(ctrl)->connect_work);
1854 nvme_tcp_teardown_io_queues(ctrl, shutdown);
1856 nvme_shutdown_ctrl(ctrl);
1858 nvme_disable_ctrl(ctrl, ctrl->cap);
1859 nvme_tcp_teardown_admin_queue(ctrl, shutdown);
1862 static void nvme_tcp_delete_ctrl(struct nvme_ctrl *ctrl)
1864 nvme_tcp_teardown_ctrl(ctrl, true);
1867 static void nvme_reset_ctrl_work(struct work_struct *work)
1869 struct nvme_ctrl *ctrl =
1870 container_of(work, struct nvme_ctrl, reset_work);
1872 nvme_stop_ctrl(ctrl);
1873 nvme_tcp_teardown_ctrl(ctrl, false);
1875 if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_CONNECTING)) {
1876 /* state change failure is ok if we're in DELETING state */
1877 WARN_ON_ONCE(ctrl->state != NVME_CTRL_DELETING);
1881 if (nvme_tcp_setup_ctrl(ctrl, false))
1887 ++ctrl->nr_reconnects;
1888 nvme_tcp_reconnect_or_remove(ctrl);
1891 static void nvme_tcp_free_ctrl(struct nvme_ctrl *nctrl)
1893 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1895 if (list_empty(&ctrl->list))
1898 mutex_lock(&nvme_tcp_ctrl_mutex);
1899 list_del(&ctrl->list);
1900 mutex_unlock(&nvme_tcp_ctrl_mutex);
1902 nvmf_free_options(nctrl->opts);
1904 kfree(ctrl->queues);
1908 static void nvme_tcp_set_sg_null(struct nvme_command *c)
1910 struct nvme_sgl_desc *sg = &c->common.dptr.sgl;
1914 sg->type = (NVME_TRANSPORT_SGL_DATA_DESC << 4) |
1915 NVME_SGL_FMT_TRANSPORT_A;
1918 static void nvme_tcp_set_sg_inline(struct nvme_tcp_queue *queue,
1919 struct nvme_command *c, u32 data_len)
1921 struct nvme_sgl_desc *sg = &c->common.dptr.sgl;
1923 sg->addr = cpu_to_le64(queue->ctrl->ctrl.icdoff);
1924 sg->length = cpu_to_le32(data_len);
1925 sg->type = (NVME_SGL_FMT_DATA_DESC << 4) | NVME_SGL_FMT_OFFSET;
1928 static void nvme_tcp_set_sg_host_data(struct nvme_command *c,
1931 struct nvme_sgl_desc *sg = &c->common.dptr.sgl;
1934 sg->length = cpu_to_le32(data_len);
1935 sg->type = (NVME_TRANSPORT_SGL_DATA_DESC << 4) |
1936 NVME_SGL_FMT_TRANSPORT_A;
1939 static void nvme_tcp_submit_async_event(struct nvme_ctrl *arg)
1941 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(arg);
1942 struct nvme_tcp_queue *queue = &ctrl->queues[0];
1943 struct nvme_tcp_cmd_pdu *pdu = ctrl->async_req.pdu;
1944 struct nvme_command *cmd = &pdu->cmd;
1945 u8 hdgst = nvme_tcp_hdgst_len(queue);
1947 memset(pdu, 0, sizeof(*pdu));
1948 pdu->hdr.type = nvme_tcp_cmd;
1949 if (queue->hdr_digest)
1950 pdu->hdr.flags |= NVME_TCP_F_HDGST;
1951 pdu->hdr.hlen = sizeof(*pdu);
1952 pdu->hdr.plen = cpu_to_le32(pdu->hdr.hlen + hdgst);
1954 cmd->common.opcode = nvme_admin_async_event;
1955 cmd->common.command_id = NVME_AQ_BLK_MQ_DEPTH;
1956 cmd->common.flags |= NVME_CMD_SGL_METABUF;
1957 nvme_tcp_set_sg_null(cmd);
1959 ctrl->async_req.state = NVME_TCP_SEND_CMD_PDU;
1960 ctrl->async_req.offset = 0;
1961 ctrl->async_req.curr_bio = NULL;
1962 ctrl->async_req.data_len = 0;
1964 nvme_tcp_queue_request(&ctrl->async_req);
1967 static enum blk_eh_timer_return
1968 nvme_tcp_timeout(struct request *rq, bool reserved)
1970 struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
1971 struct nvme_tcp_ctrl *ctrl = req->queue->ctrl;
1972 struct nvme_tcp_cmd_pdu *pdu = req->pdu;
1974 dev_warn(ctrl->ctrl.device,
1975 "queue %d: timeout request %#x type %d\n",
1976 nvme_tcp_queue_id(req->queue), rq->tag, pdu->hdr.type);
1978 if (ctrl->ctrl.state != NVME_CTRL_LIVE) {
1980 * Teardown immediately if controller times out while starting
1981 * or we are already started error recovery. all outstanding
1982 * requests are completed on shutdown, so we return BLK_EH_DONE.
1984 flush_work(&ctrl->err_work);
1985 nvme_tcp_teardown_io_queues(&ctrl->ctrl, false);
1986 nvme_tcp_teardown_admin_queue(&ctrl->ctrl, false);
1990 dev_warn(ctrl->ctrl.device, "starting error recovery\n");
1991 nvme_tcp_error_recovery(&ctrl->ctrl);
1993 return BLK_EH_RESET_TIMER;
1996 static blk_status_t nvme_tcp_map_data(struct nvme_tcp_queue *queue,
1999 struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
2000 struct nvme_tcp_cmd_pdu *pdu = req->pdu;
2001 struct nvme_command *c = &pdu->cmd;
2003 c->common.flags |= NVME_CMD_SGL_METABUF;
2005 if (rq_data_dir(rq) == WRITE && req->data_len &&
2006 req->data_len <= nvme_tcp_inline_data_size(queue))
2007 nvme_tcp_set_sg_inline(queue, c, req->data_len);
2009 nvme_tcp_set_sg_host_data(c, req->data_len);
2014 static blk_status_t nvme_tcp_setup_cmd_pdu(struct nvme_ns *ns,
2017 struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
2018 struct nvme_tcp_cmd_pdu *pdu = req->pdu;
2019 struct nvme_tcp_queue *queue = req->queue;
2020 u8 hdgst = nvme_tcp_hdgst_len(queue), ddgst = 0;
2023 ret = nvme_setup_cmd(ns, rq, &pdu->cmd);
2027 req->state = NVME_TCP_SEND_CMD_PDU;
2032 req->data_len = blk_rq_payload_bytes(rq);
2033 req->curr_bio = rq->bio;
2035 if (rq_data_dir(rq) == WRITE &&
2036 req->data_len <= nvme_tcp_inline_data_size(queue))
2037 req->pdu_len = req->data_len;
2038 else if (req->curr_bio)
2039 nvme_tcp_init_iter(req, READ);
2041 pdu->hdr.type = nvme_tcp_cmd;
2043 if (queue->hdr_digest)
2044 pdu->hdr.flags |= NVME_TCP_F_HDGST;
2045 if (queue->data_digest && req->pdu_len) {
2046 pdu->hdr.flags |= NVME_TCP_F_DDGST;
2047 ddgst = nvme_tcp_ddgst_len(queue);
2049 pdu->hdr.hlen = sizeof(*pdu);
2050 pdu->hdr.pdo = req->pdu_len ? pdu->hdr.hlen + hdgst : 0;
2052 cpu_to_le32(pdu->hdr.hlen + hdgst + req->pdu_len + ddgst);
2054 ret = nvme_tcp_map_data(queue, rq);
2055 if (unlikely(ret)) {
2056 dev_err(queue->ctrl->ctrl.device,
2057 "Failed to map data (%d)\n", ret);
2064 static blk_status_t nvme_tcp_queue_rq(struct blk_mq_hw_ctx *hctx,
2065 const struct blk_mq_queue_data *bd)
2067 struct nvme_ns *ns = hctx->queue->queuedata;
2068 struct nvme_tcp_queue *queue = hctx->driver_data;
2069 struct request *rq = bd->rq;
2070 struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
2071 bool queue_ready = test_bit(NVME_TCP_Q_LIVE, &queue->flags);
2074 if (!nvmf_check_ready(&queue->ctrl->ctrl, rq, queue_ready))
2075 return nvmf_fail_nonready_command(&queue->ctrl->ctrl, rq);
2077 ret = nvme_tcp_setup_cmd_pdu(ns, rq);
2081 blk_mq_start_request(rq);
2083 nvme_tcp_queue_request(req);
2088 static int nvme_tcp_map_queues(struct blk_mq_tag_set *set)
2090 struct nvme_tcp_ctrl *ctrl = set->driver_data;
2092 set->map[HCTX_TYPE_DEFAULT].queue_offset = 0;
2093 set->map[HCTX_TYPE_READ].nr_queues = ctrl->ctrl.opts->nr_io_queues;
2094 if (ctrl->ctrl.opts->nr_write_queues) {
2095 /* separate read/write queues */
2096 set->map[HCTX_TYPE_DEFAULT].nr_queues =
2097 ctrl->ctrl.opts->nr_write_queues;
2098 set->map[HCTX_TYPE_READ].queue_offset =
2099 ctrl->ctrl.opts->nr_write_queues;
2101 /* mixed read/write queues */
2102 set->map[HCTX_TYPE_DEFAULT].nr_queues =
2103 ctrl->ctrl.opts->nr_io_queues;
2104 set->map[HCTX_TYPE_READ].queue_offset = 0;
2106 blk_mq_map_queues(&set->map[HCTX_TYPE_DEFAULT]);
2107 blk_mq_map_queues(&set->map[HCTX_TYPE_READ]);
2111 static struct blk_mq_ops nvme_tcp_mq_ops = {
2112 .queue_rq = nvme_tcp_queue_rq,
2113 .complete = nvme_complete_rq,
2114 .init_request = nvme_tcp_init_request,
2115 .exit_request = nvme_tcp_exit_request,
2116 .init_hctx = nvme_tcp_init_hctx,
2117 .timeout = nvme_tcp_timeout,
2118 .map_queues = nvme_tcp_map_queues,
2121 static struct blk_mq_ops nvme_tcp_admin_mq_ops = {
2122 .queue_rq = nvme_tcp_queue_rq,
2123 .complete = nvme_complete_rq,
2124 .init_request = nvme_tcp_init_request,
2125 .exit_request = nvme_tcp_exit_request,
2126 .init_hctx = nvme_tcp_init_admin_hctx,
2127 .timeout = nvme_tcp_timeout,
2130 static const struct nvme_ctrl_ops nvme_tcp_ctrl_ops = {
2132 .module = THIS_MODULE,
2133 .flags = NVME_F_FABRICS,
2134 .reg_read32 = nvmf_reg_read32,
2135 .reg_read64 = nvmf_reg_read64,
2136 .reg_write32 = nvmf_reg_write32,
2137 .free_ctrl = nvme_tcp_free_ctrl,
2138 .submit_async_event = nvme_tcp_submit_async_event,
2139 .delete_ctrl = nvme_tcp_delete_ctrl,
2140 .get_address = nvmf_get_address,
2144 nvme_tcp_existing_controller(struct nvmf_ctrl_options *opts)
2146 struct nvme_tcp_ctrl *ctrl;
2149 mutex_lock(&nvme_tcp_ctrl_mutex);
2150 list_for_each_entry(ctrl, &nvme_tcp_ctrl_list, list) {
2151 found = nvmf_ip_options_match(&ctrl->ctrl, opts);
2155 mutex_unlock(&nvme_tcp_ctrl_mutex);
2160 static struct nvme_ctrl *nvme_tcp_create_ctrl(struct device *dev,
2161 struct nvmf_ctrl_options *opts)
2163 struct nvme_tcp_ctrl *ctrl;
2166 ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
2168 return ERR_PTR(-ENOMEM);
2170 INIT_LIST_HEAD(&ctrl->list);
2171 ctrl->ctrl.opts = opts;
2172 ctrl->ctrl.queue_count = opts->nr_io_queues + opts->nr_write_queues + 1;
2173 ctrl->ctrl.sqsize = opts->queue_size - 1;
2174 ctrl->ctrl.kato = opts->kato;
2176 INIT_DELAYED_WORK(&ctrl->connect_work,
2177 nvme_tcp_reconnect_ctrl_work);
2178 INIT_WORK(&ctrl->err_work, nvme_tcp_error_recovery_work);
2179 INIT_WORK(&ctrl->ctrl.reset_work, nvme_reset_ctrl_work);
2181 if (!(opts->mask & NVMF_OPT_TRSVCID)) {
2183 kstrdup(__stringify(NVME_TCP_DISC_PORT), GFP_KERNEL);
2184 if (!opts->trsvcid) {
2188 opts->mask |= NVMF_OPT_TRSVCID;
2191 ret = inet_pton_with_scope(&init_net, AF_UNSPEC,
2192 opts->traddr, opts->trsvcid, &ctrl->addr);
2194 pr_err("malformed address passed: %s:%s\n",
2195 opts->traddr, opts->trsvcid);
2199 if (opts->mask & NVMF_OPT_HOST_TRADDR) {
2200 ret = inet_pton_with_scope(&init_net, AF_UNSPEC,
2201 opts->host_traddr, NULL, &ctrl->src_addr);
2203 pr_err("malformed src address passed: %s\n",
2209 if (!opts->duplicate_connect && nvme_tcp_existing_controller(opts)) {
2214 ctrl->queues = kcalloc(ctrl->ctrl.queue_count, sizeof(*ctrl->queues),
2216 if (!ctrl->queues) {
2221 ret = nvme_init_ctrl(&ctrl->ctrl, dev, &nvme_tcp_ctrl_ops, 0);
2223 goto out_kfree_queues;
2225 if (!nvme_change_ctrl_state(&ctrl->ctrl, NVME_CTRL_CONNECTING)) {
2228 goto out_uninit_ctrl;
2231 ret = nvme_tcp_setup_ctrl(&ctrl->ctrl, true);
2233 goto out_uninit_ctrl;
2235 dev_info(ctrl->ctrl.device, "new ctrl: NQN \"%s\", addr %pISp\n",
2236 ctrl->ctrl.opts->subsysnqn, &ctrl->addr);
2238 nvme_get_ctrl(&ctrl->ctrl);
2240 mutex_lock(&nvme_tcp_ctrl_mutex);
2241 list_add_tail(&ctrl->list, &nvme_tcp_ctrl_list);
2242 mutex_unlock(&nvme_tcp_ctrl_mutex);
2247 nvme_uninit_ctrl(&ctrl->ctrl);
2248 nvme_put_ctrl(&ctrl->ctrl);
2251 return ERR_PTR(ret);
2253 kfree(ctrl->queues);
2256 return ERR_PTR(ret);
2259 static struct nvmf_transport_ops nvme_tcp_transport = {
2261 .module = THIS_MODULE,
2262 .required_opts = NVMF_OPT_TRADDR,
2263 .allowed_opts = NVMF_OPT_TRSVCID | NVMF_OPT_RECONNECT_DELAY |
2264 NVMF_OPT_HOST_TRADDR | NVMF_OPT_CTRL_LOSS_TMO |
2265 NVMF_OPT_HDR_DIGEST | NVMF_OPT_DATA_DIGEST |
2266 NVMF_OPT_NR_WRITE_QUEUES,
2267 .create_ctrl = nvme_tcp_create_ctrl,
2270 static int __init nvme_tcp_init_module(void)
2272 nvme_tcp_wq = alloc_workqueue("nvme_tcp_wq",
2273 WQ_MEM_RECLAIM | WQ_HIGHPRI, 0);
2277 nvmf_register_transport(&nvme_tcp_transport);
2281 static void __exit nvme_tcp_cleanup_module(void)
2283 struct nvme_tcp_ctrl *ctrl;
2285 nvmf_unregister_transport(&nvme_tcp_transport);
2287 mutex_lock(&nvme_tcp_ctrl_mutex);
2288 list_for_each_entry(ctrl, &nvme_tcp_ctrl_list, list)
2289 nvme_delete_ctrl(&ctrl->ctrl);
2290 mutex_unlock(&nvme_tcp_ctrl_mutex);
2291 flush_workqueue(nvme_delete_wq);
2293 destroy_workqueue(nvme_tcp_wq);
2296 module_init(nvme_tcp_init_module);
2297 module_exit(nvme_tcp_cleanup_module);
2299 MODULE_LICENSE("GPL v2");