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>
16 #include <net/busy_poll.h>
21 struct nvme_tcp_queue;
23 /* Define the socket priority to use for connections were it is desirable
24 * that the NIC consider performing optimized packet processing or filtering.
25 * A non-zero value being sufficient to indicate general consideration of any
26 * possible optimization. Making it a module param allows for alternative
27 * values that may be unique for some NIC implementations.
29 static int so_priority;
30 module_param(so_priority, int, 0644);
31 MODULE_PARM_DESC(so_priority, "nvme tcp socket optimize priority");
33 enum nvme_tcp_send_state {
34 NVME_TCP_SEND_CMD_PDU = 0,
35 NVME_TCP_SEND_H2C_PDU,
40 struct nvme_tcp_request {
41 struct nvme_request req;
43 struct nvme_tcp_queue *queue;
48 struct list_head entry;
49 struct llist_node lentry;
58 enum nvme_tcp_send_state state;
61 enum nvme_tcp_queue_flags {
62 NVME_TCP_Q_ALLOCATED = 0,
64 NVME_TCP_Q_POLLING = 2,
67 enum nvme_tcp_recv_state {
68 NVME_TCP_RECV_PDU = 0,
74 struct nvme_tcp_queue {
76 struct work_struct io_work;
79 struct mutex queue_lock;
80 struct mutex send_mutex;
81 struct llist_head req_list;
82 struct list_head send_list;
89 size_t data_remaining;
90 size_t ddgst_remaining;
94 struct nvme_tcp_request *request;
97 size_t cmnd_capsule_len;
98 struct nvme_tcp_ctrl *ctrl;
104 struct ahash_request *rcv_hash;
105 struct ahash_request *snd_hash;
109 struct page_frag_cache pf_cache;
111 void (*state_change)(struct sock *);
112 void (*data_ready)(struct sock *);
113 void (*write_space)(struct sock *);
116 struct nvme_tcp_ctrl {
117 /* read only in the hot path */
118 struct nvme_tcp_queue *queues;
119 struct blk_mq_tag_set tag_set;
121 /* other member variables */
122 struct list_head list;
123 struct blk_mq_tag_set admin_tag_set;
124 struct sockaddr_storage addr;
125 struct sockaddr_storage src_addr;
126 struct nvme_ctrl ctrl;
128 struct work_struct err_work;
129 struct delayed_work connect_work;
130 struct nvme_tcp_request async_req;
131 u32 io_queues[HCTX_MAX_TYPES];
134 static LIST_HEAD(nvme_tcp_ctrl_list);
135 static DEFINE_MUTEX(nvme_tcp_ctrl_mutex);
136 static struct workqueue_struct *nvme_tcp_wq;
137 static const struct blk_mq_ops nvme_tcp_mq_ops;
138 static const struct blk_mq_ops nvme_tcp_admin_mq_ops;
139 static int nvme_tcp_try_send(struct nvme_tcp_queue *queue);
141 static inline struct nvme_tcp_ctrl *to_tcp_ctrl(struct nvme_ctrl *ctrl)
143 return container_of(ctrl, struct nvme_tcp_ctrl, ctrl);
146 static inline int nvme_tcp_queue_id(struct nvme_tcp_queue *queue)
148 return queue - queue->ctrl->queues;
151 static inline struct blk_mq_tags *nvme_tcp_tagset(struct nvme_tcp_queue *queue)
153 u32 queue_idx = nvme_tcp_queue_id(queue);
156 return queue->ctrl->admin_tag_set.tags[queue_idx];
157 return queue->ctrl->tag_set.tags[queue_idx - 1];
160 static inline u8 nvme_tcp_hdgst_len(struct nvme_tcp_queue *queue)
162 return queue->hdr_digest ? NVME_TCP_DIGEST_LENGTH : 0;
165 static inline u8 nvme_tcp_ddgst_len(struct nvme_tcp_queue *queue)
167 return queue->data_digest ? NVME_TCP_DIGEST_LENGTH : 0;
170 static inline size_t nvme_tcp_inline_data_size(struct nvme_tcp_queue *queue)
172 return queue->cmnd_capsule_len - sizeof(struct nvme_command);
175 static inline bool nvme_tcp_async_req(struct nvme_tcp_request *req)
177 return req == &req->queue->ctrl->async_req;
180 static inline bool nvme_tcp_has_inline_data(struct nvme_tcp_request *req)
184 if (unlikely(nvme_tcp_async_req(req)))
185 return false; /* async events don't have a request */
187 rq = blk_mq_rq_from_pdu(req);
189 return rq_data_dir(rq) == WRITE && req->data_len &&
190 req->data_len <= nvme_tcp_inline_data_size(req->queue);
193 static inline struct page *nvme_tcp_req_cur_page(struct nvme_tcp_request *req)
195 return req->iter.bvec->bv_page;
198 static inline size_t nvme_tcp_req_cur_offset(struct nvme_tcp_request *req)
200 return req->iter.bvec->bv_offset + req->iter.iov_offset;
203 static inline size_t nvme_tcp_req_cur_length(struct nvme_tcp_request *req)
205 return min_t(size_t, iov_iter_single_seg_count(&req->iter),
206 req->pdu_len - req->pdu_sent);
209 static inline size_t nvme_tcp_pdu_data_left(struct nvme_tcp_request *req)
211 return rq_data_dir(blk_mq_rq_from_pdu(req)) == WRITE ?
212 req->pdu_len - req->pdu_sent : 0;
215 static inline size_t nvme_tcp_pdu_last_send(struct nvme_tcp_request *req,
218 return nvme_tcp_pdu_data_left(req) <= len;
221 static void nvme_tcp_init_iter(struct nvme_tcp_request *req,
224 struct request *rq = blk_mq_rq_from_pdu(req);
230 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD) {
231 vec = &rq->special_vec;
233 size = blk_rq_payload_bytes(rq);
236 struct bio *bio = req->curr_bio;
240 vec = __bvec_iter_bvec(bio->bi_io_vec, bio->bi_iter);
242 bio_for_each_bvec(bv, bio, bi) {
245 size = bio->bi_iter.bi_size;
246 offset = bio->bi_iter.bi_bvec_done;
249 iov_iter_bvec(&req->iter, dir, vec, nr_bvec, size);
250 req->iter.iov_offset = offset;
253 static inline void nvme_tcp_advance_req(struct nvme_tcp_request *req,
256 req->data_sent += len;
257 req->pdu_sent += len;
258 iov_iter_advance(&req->iter, len);
259 if (!iov_iter_count(&req->iter) &&
260 req->data_sent < req->data_len) {
261 req->curr_bio = req->curr_bio->bi_next;
262 nvme_tcp_init_iter(req, WRITE);
266 static inline void nvme_tcp_send_all(struct nvme_tcp_queue *queue)
270 /* drain the send queue as much as we can... */
272 ret = nvme_tcp_try_send(queue);
276 static inline void nvme_tcp_queue_request(struct nvme_tcp_request *req,
277 bool sync, bool last)
279 struct nvme_tcp_queue *queue = req->queue;
282 empty = llist_add(&req->lentry, &queue->req_list) &&
283 list_empty(&queue->send_list) && !queue->request;
286 * if we're the first on the send_list and we can try to send
287 * directly, otherwise queue io_work. Also, only do that if we
288 * are on the same cpu, so we don't introduce contention.
290 if (queue->io_cpu == raw_smp_processor_id() &&
291 sync && empty && mutex_trylock(&queue->send_mutex)) {
292 queue->more_requests = !last;
293 nvme_tcp_send_all(queue);
294 queue->more_requests = false;
295 mutex_unlock(&queue->send_mutex);
297 queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
301 static void nvme_tcp_process_req_list(struct nvme_tcp_queue *queue)
303 struct nvme_tcp_request *req;
304 struct llist_node *node;
306 for (node = llist_del_all(&queue->req_list); node; node = node->next) {
307 req = llist_entry(node, struct nvme_tcp_request, lentry);
308 list_add(&req->entry, &queue->send_list);
312 static inline struct nvme_tcp_request *
313 nvme_tcp_fetch_request(struct nvme_tcp_queue *queue)
315 struct nvme_tcp_request *req;
317 req = list_first_entry_or_null(&queue->send_list,
318 struct nvme_tcp_request, entry);
320 nvme_tcp_process_req_list(queue);
321 req = list_first_entry_or_null(&queue->send_list,
322 struct nvme_tcp_request, entry);
327 list_del(&req->entry);
331 static inline void nvme_tcp_ddgst_final(struct ahash_request *hash,
334 ahash_request_set_crypt(hash, NULL, (u8 *)dgst, 0);
335 crypto_ahash_final(hash);
338 static inline void nvme_tcp_ddgst_update(struct ahash_request *hash,
339 struct page *page, off_t off, size_t len)
341 struct scatterlist sg;
343 sg_init_marker(&sg, 1);
344 sg_set_page(&sg, page, len, off);
345 ahash_request_set_crypt(hash, &sg, NULL, len);
346 crypto_ahash_update(hash);
349 static inline void nvme_tcp_hdgst(struct ahash_request *hash,
350 void *pdu, size_t len)
352 struct scatterlist sg;
354 sg_init_one(&sg, pdu, len);
355 ahash_request_set_crypt(hash, &sg, pdu + len, len);
356 crypto_ahash_digest(hash);
359 static int nvme_tcp_verify_hdgst(struct nvme_tcp_queue *queue,
360 void *pdu, size_t pdu_len)
362 struct nvme_tcp_hdr *hdr = pdu;
366 if (unlikely(!(hdr->flags & NVME_TCP_F_HDGST))) {
367 dev_err(queue->ctrl->ctrl.device,
368 "queue %d: header digest flag is cleared\n",
369 nvme_tcp_queue_id(queue));
373 recv_digest = *(__le32 *)(pdu + hdr->hlen);
374 nvme_tcp_hdgst(queue->rcv_hash, pdu, pdu_len);
375 exp_digest = *(__le32 *)(pdu + hdr->hlen);
376 if (recv_digest != exp_digest) {
377 dev_err(queue->ctrl->ctrl.device,
378 "header digest error: recv %#x expected %#x\n",
379 le32_to_cpu(recv_digest), le32_to_cpu(exp_digest));
386 static int nvme_tcp_check_ddgst(struct nvme_tcp_queue *queue, void *pdu)
388 struct nvme_tcp_hdr *hdr = pdu;
389 u8 digest_len = nvme_tcp_hdgst_len(queue);
392 len = le32_to_cpu(hdr->plen) - hdr->hlen -
393 ((hdr->flags & NVME_TCP_F_HDGST) ? digest_len : 0);
395 if (unlikely(len && !(hdr->flags & NVME_TCP_F_DDGST))) {
396 dev_err(queue->ctrl->ctrl.device,
397 "queue %d: data digest flag is cleared\n",
398 nvme_tcp_queue_id(queue));
401 crypto_ahash_init(queue->rcv_hash);
406 static void nvme_tcp_exit_request(struct blk_mq_tag_set *set,
407 struct request *rq, unsigned int hctx_idx)
409 struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
411 page_frag_free(req->pdu);
414 static int nvme_tcp_init_request(struct blk_mq_tag_set *set,
415 struct request *rq, unsigned int hctx_idx,
416 unsigned int numa_node)
418 struct nvme_tcp_ctrl *ctrl = set->driver_data;
419 struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
420 struct nvme_tcp_cmd_pdu *pdu;
421 int queue_idx = (set == &ctrl->tag_set) ? hctx_idx + 1 : 0;
422 struct nvme_tcp_queue *queue = &ctrl->queues[queue_idx];
423 u8 hdgst = nvme_tcp_hdgst_len(queue);
425 req->pdu = page_frag_alloc(&queue->pf_cache,
426 sizeof(struct nvme_tcp_cmd_pdu) + hdgst,
427 GFP_KERNEL | __GFP_ZERO);
433 nvme_req(rq)->ctrl = &ctrl->ctrl;
434 nvme_req(rq)->cmd = &pdu->cmd;
439 static int nvme_tcp_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
440 unsigned int hctx_idx)
442 struct nvme_tcp_ctrl *ctrl = data;
443 struct nvme_tcp_queue *queue = &ctrl->queues[hctx_idx + 1];
445 hctx->driver_data = queue;
449 static int nvme_tcp_init_admin_hctx(struct blk_mq_hw_ctx *hctx, void *data,
450 unsigned int hctx_idx)
452 struct nvme_tcp_ctrl *ctrl = data;
453 struct nvme_tcp_queue *queue = &ctrl->queues[0];
455 hctx->driver_data = queue;
459 static enum nvme_tcp_recv_state
460 nvme_tcp_recv_state(struct nvme_tcp_queue *queue)
462 return (queue->pdu_remaining) ? NVME_TCP_RECV_PDU :
463 (queue->ddgst_remaining) ? NVME_TCP_RECV_DDGST :
467 static void nvme_tcp_init_recv_ctx(struct nvme_tcp_queue *queue)
469 queue->pdu_remaining = sizeof(struct nvme_tcp_rsp_pdu) +
470 nvme_tcp_hdgst_len(queue);
471 queue->pdu_offset = 0;
472 queue->data_remaining = -1;
473 queue->ddgst_remaining = 0;
476 static void nvme_tcp_error_recovery(struct nvme_ctrl *ctrl)
478 if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING))
481 dev_warn(ctrl->device, "starting error recovery\n");
482 queue_work(nvme_reset_wq, &to_tcp_ctrl(ctrl)->err_work);
485 static int nvme_tcp_process_nvme_cqe(struct nvme_tcp_queue *queue,
486 struct nvme_completion *cqe)
490 rq = blk_mq_tag_to_rq(nvme_tcp_tagset(queue), cqe->command_id);
492 dev_err(queue->ctrl->ctrl.device,
493 "queue %d tag 0x%x not found\n",
494 nvme_tcp_queue_id(queue), cqe->command_id);
495 nvme_tcp_error_recovery(&queue->ctrl->ctrl);
499 if (!nvme_try_complete_req(rq, cqe->status, cqe->result))
500 nvme_complete_rq(rq);
506 static int nvme_tcp_handle_c2h_data(struct nvme_tcp_queue *queue,
507 struct nvme_tcp_data_pdu *pdu)
511 rq = blk_mq_tag_to_rq(nvme_tcp_tagset(queue), pdu->command_id);
513 dev_err(queue->ctrl->ctrl.device,
514 "queue %d tag %#x not found\n",
515 nvme_tcp_queue_id(queue), pdu->command_id);
519 if (!blk_rq_payload_bytes(rq)) {
520 dev_err(queue->ctrl->ctrl.device,
521 "queue %d tag %#x unexpected data\n",
522 nvme_tcp_queue_id(queue), rq->tag);
526 queue->data_remaining = le32_to_cpu(pdu->data_length);
528 if (pdu->hdr.flags & NVME_TCP_F_DATA_SUCCESS &&
529 unlikely(!(pdu->hdr.flags & NVME_TCP_F_DATA_LAST))) {
530 dev_err(queue->ctrl->ctrl.device,
531 "queue %d tag %#x SUCCESS set but not last PDU\n",
532 nvme_tcp_queue_id(queue), rq->tag);
533 nvme_tcp_error_recovery(&queue->ctrl->ctrl);
540 static int nvme_tcp_handle_comp(struct nvme_tcp_queue *queue,
541 struct nvme_tcp_rsp_pdu *pdu)
543 struct nvme_completion *cqe = &pdu->cqe;
547 * AEN requests are special as they don't time out and can
548 * survive any kind of queue freeze and often don't respond to
549 * aborts. We don't even bother to allocate a struct request
550 * for them but rather special case them here.
552 if (unlikely(nvme_is_aen_req(nvme_tcp_queue_id(queue),
554 nvme_complete_async_event(&queue->ctrl->ctrl, cqe->status,
557 ret = nvme_tcp_process_nvme_cqe(queue, cqe);
562 static int nvme_tcp_setup_h2c_data_pdu(struct nvme_tcp_request *req,
563 struct nvme_tcp_r2t_pdu *pdu)
565 struct nvme_tcp_data_pdu *data = req->pdu;
566 struct nvme_tcp_queue *queue = req->queue;
567 struct request *rq = blk_mq_rq_from_pdu(req);
568 u8 hdgst = nvme_tcp_hdgst_len(queue);
569 u8 ddgst = nvme_tcp_ddgst_len(queue);
571 req->pdu_len = le32_to_cpu(pdu->r2t_length);
574 if (unlikely(!req->pdu_len)) {
575 dev_err(queue->ctrl->ctrl.device,
576 "req %d r2t len is %u, probably a bug...\n",
577 rq->tag, req->pdu_len);
581 if (unlikely(req->data_sent + req->pdu_len > req->data_len)) {
582 dev_err(queue->ctrl->ctrl.device,
583 "req %d r2t len %u exceeded data len %u (%zu sent)\n",
584 rq->tag, req->pdu_len, req->data_len,
589 if (unlikely(le32_to_cpu(pdu->r2t_offset) < req->data_sent)) {
590 dev_err(queue->ctrl->ctrl.device,
591 "req %d unexpected r2t offset %u (expected %zu)\n",
592 rq->tag, le32_to_cpu(pdu->r2t_offset),
597 memset(data, 0, sizeof(*data));
598 data->hdr.type = nvme_tcp_h2c_data;
599 data->hdr.flags = NVME_TCP_F_DATA_LAST;
600 if (queue->hdr_digest)
601 data->hdr.flags |= NVME_TCP_F_HDGST;
602 if (queue->data_digest)
603 data->hdr.flags |= NVME_TCP_F_DDGST;
604 data->hdr.hlen = sizeof(*data);
605 data->hdr.pdo = data->hdr.hlen + hdgst;
607 cpu_to_le32(data->hdr.hlen + hdgst + req->pdu_len + ddgst);
608 data->ttag = pdu->ttag;
609 data->command_id = rq->tag;
610 data->data_offset = cpu_to_le32(req->data_sent);
611 data->data_length = cpu_to_le32(req->pdu_len);
615 static int nvme_tcp_handle_r2t(struct nvme_tcp_queue *queue,
616 struct nvme_tcp_r2t_pdu *pdu)
618 struct nvme_tcp_request *req;
622 rq = blk_mq_tag_to_rq(nvme_tcp_tagset(queue), pdu->command_id);
624 dev_err(queue->ctrl->ctrl.device,
625 "queue %d tag %#x not found\n",
626 nvme_tcp_queue_id(queue), pdu->command_id);
629 req = blk_mq_rq_to_pdu(rq);
631 ret = nvme_tcp_setup_h2c_data_pdu(req, pdu);
635 req->state = NVME_TCP_SEND_H2C_PDU;
638 nvme_tcp_queue_request(req, false, true);
643 static int nvme_tcp_recv_pdu(struct nvme_tcp_queue *queue, struct sk_buff *skb,
644 unsigned int *offset, size_t *len)
646 struct nvme_tcp_hdr *hdr;
647 char *pdu = queue->pdu;
648 size_t rcv_len = min_t(size_t, *len, queue->pdu_remaining);
651 ret = skb_copy_bits(skb, *offset,
652 &pdu[queue->pdu_offset], rcv_len);
656 queue->pdu_remaining -= rcv_len;
657 queue->pdu_offset += rcv_len;
660 if (queue->pdu_remaining)
664 if (queue->hdr_digest) {
665 ret = nvme_tcp_verify_hdgst(queue, queue->pdu, hdr->hlen);
671 if (queue->data_digest) {
672 ret = nvme_tcp_check_ddgst(queue, queue->pdu);
678 case nvme_tcp_c2h_data:
679 return nvme_tcp_handle_c2h_data(queue, (void *)queue->pdu);
681 nvme_tcp_init_recv_ctx(queue);
682 return nvme_tcp_handle_comp(queue, (void *)queue->pdu);
684 nvme_tcp_init_recv_ctx(queue);
685 return nvme_tcp_handle_r2t(queue, (void *)queue->pdu);
687 dev_err(queue->ctrl->ctrl.device,
688 "unsupported pdu type (%d)\n", hdr->type);
693 static inline void nvme_tcp_end_request(struct request *rq, u16 status)
695 union nvme_result res = {};
697 if (!nvme_try_complete_req(rq, cpu_to_le16(status << 1), res))
698 nvme_complete_rq(rq);
701 static int nvme_tcp_recv_data(struct nvme_tcp_queue *queue, struct sk_buff *skb,
702 unsigned int *offset, size_t *len)
704 struct nvme_tcp_data_pdu *pdu = (void *)queue->pdu;
705 struct nvme_tcp_request *req;
708 rq = blk_mq_tag_to_rq(nvme_tcp_tagset(queue), pdu->command_id);
710 dev_err(queue->ctrl->ctrl.device,
711 "queue %d tag %#x not found\n",
712 nvme_tcp_queue_id(queue), pdu->command_id);
715 req = blk_mq_rq_to_pdu(rq);
720 recv_len = min_t(size_t, *len, queue->data_remaining);
724 if (!iov_iter_count(&req->iter)) {
725 req->curr_bio = req->curr_bio->bi_next;
728 * If we don`t have any bios it means that controller
729 * sent more data than we requested, hence error
731 if (!req->curr_bio) {
732 dev_err(queue->ctrl->ctrl.device,
733 "queue %d no space in request %#x",
734 nvme_tcp_queue_id(queue), rq->tag);
735 nvme_tcp_init_recv_ctx(queue);
738 nvme_tcp_init_iter(req, READ);
741 /* we can read only from what is left in this bio */
742 recv_len = min_t(size_t, recv_len,
743 iov_iter_count(&req->iter));
745 if (queue->data_digest)
746 ret = skb_copy_and_hash_datagram_iter(skb, *offset,
747 &req->iter, recv_len, queue->rcv_hash);
749 ret = skb_copy_datagram_iter(skb, *offset,
750 &req->iter, recv_len);
752 dev_err(queue->ctrl->ctrl.device,
753 "queue %d failed to copy request %#x data",
754 nvme_tcp_queue_id(queue), rq->tag);
760 queue->data_remaining -= recv_len;
763 if (!queue->data_remaining) {
764 if (queue->data_digest) {
765 nvme_tcp_ddgst_final(queue->rcv_hash, &queue->exp_ddgst);
766 queue->ddgst_remaining = NVME_TCP_DIGEST_LENGTH;
768 if (pdu->hdr.flags & NVME_TCP_F_DATA_SUCCESS) {
769 nvme_tcp_end_request(rq, NVME_SC_SUCCESS);
772 nvme_tcp_init_recv_ctx(queue);
779 static int nvme_tcp_recv_ddgst(struct nvme_tcp_queue *queue,
780 struct sk_buff *skb, unsigned int *offset, size_t *len)
782 struct nvme_tcp_data_pdu *pdu = (void *)queue->pdu;
783 char *ddgst = (char *)&queue->recv_ddgst;
784 size_t recv_len = min_t(size_t, *len, queue->ddgst_remaining);
785 off_t off = NVME_TCP_DIGEST_LENGTH - queue->ddgst_remaining;
788 ret = skb_copy_bits(skb, *offset, &ddgst[off], recv_len);
792 queue->ddgst_remaining -= recv_len;
795 if (queue->ddgst_remaining)
798 if (queue->recv_ddgst != queue->exp_ddgst) {
799 dev_err(queue->ctrl->ctrl.device,
800 "data digest error: recv %#x expected %#x\n",
801 le32_to_cpu(queue->recv_ddgst),
802 le32_to_cpu(queue->exp_ddgst));
806 if (pdu->hdr.flags & NVME_TCP_F_DATA_SUCCESS) {
807 struct request *rq = blk_mq_tag_to_rq(nvme_tcp_tagset(queue),
810 nvme_tcp_end_request(rq, NVME_SC_SUCCESS);
814 nvme_tcp_init_recv_ctx(queue);
818 static int nvme_tcp_recv_skb(read_descriptor_t *desc, struct sk_buff *skb,
819 unsigned int offset, size_t len)
821 struct nvme_tcp_queue *queue = desc->arg.data;
822 size_t consumed = len;
826 switch (nvme_tcp_recv_state(queue)) {
827 case NVME_TCP_RECV_PDU:
828 result = nvme_tcp_recv_pdu(queue, skb, &offset, &len);
830 case NVME_TCP_RECV_DATA:
831 result = nvme_tcp_recv_data(queue, skb, &offset, &len);
833 case NVME_TCP_RECV_DDGST:
834 result = nvme_tcp_recv_ddgst(queue, skb, &offset, &len);
840 dev_err(queue->ctrl->ctrl.device,
841 "receive failed: %d\n", result);
842 queue->rd_enabled = false;
843 nvme_tcp_error_recovery(&queue->ctrl->ctrl);
851 static void nvme_tcp_data_ready(struct sock *sk)
853 struct nvme_tcp_queue *queue;
855 read_lock_bh(&sk->sk_callback_lock);
856 queue = sk->sk_user_data;
857 if (likely(queue && queue->rd_enabled) &&
858 !test_bit(NVME_TCP_Q_POLLING, &queue->flags))
859 queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
860 read_unlock_bh(&sk->sk_callback_lock);
863 static void nvme_tcp_write_space(struct sock *sk)
865 struct nvme_tcp_queue *queue;
867 read_lock_bh(&sk->sk_callback_lock);
868 queue = sk->sk_user_data;
869 if (likely(queue && sk_stream_is_writeable(sk))) {
870 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
871 queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
873 read_unlock_bh(&sk->sk_callback_lock);
876 static void nvme_tcp_state_change(struct sock *sk)
878 struct nvme_tcp_queue *queue;
880 read_lock_bh(&sk->sk_callback_lock);
881 queue = sk->sk_user_data;
885 switch (sk->sk_state) {
891 nvme_tcp_error_recovery(&queue->ctrl->ctrl);
894 dev_info(queue->ctrl->ctrl.device,
895 "queue %d socket state %d\n",
896 nvme_tcp_queue_id(queue), sk->sk_state);
899 queue->state_change(sk);
901 read_unlock_bh(&sk->sk_callback_lock);
904 static inline bool nvme_tcp_queue_more(struct nvme_tcp_queue *queue)
906 return !list_empty(&queue->send_list) ||
907 !llist_empty(&queue->req_list) || queue->more_requests;
910 static inline void nvme_tcp_done_send_req(struct nvme_tcp_queue *queue)
912 queue->request = NULL;
915 static void nvme_tcp_fail_request(struct nvme_tcp_request *req)
917 nvme_tcp_end_request(blk_mq_rq_from_pdu(req), NVME_SC_HOST_PATH_ERROR);
920 static int nvme_tcp_try_send_data(struct nvme_tcp_request *req)
922 struct nvme_tcp_queue *queue = req->queue;
925 struct page *page = nvme_tcp_req_cur_page(req);
926 size_t offset = nvme_tcp_req_cur_offset(req);
927 size_t len = nvme_tcp_req_cur_length(req);
928 bool last = nvme_tcp_pdu_last_send(req, len);
929 int ret, flags = MSG_DONTWAIT;
931 if (last && !queue->data_digest && !nvme_tcp_queue_more(queue))
934 flags |= MSG_MORE | MSG_SENDPAGE_NOTLAST;
936 if (sendpage_ok(page)) {
937 ret = kernel_sendpage(queue->sock, page, offset, len,
940 ret = sock_no_sendpage(queue->sock, page, offset, len,
946 nvme_tcp_advance_req(req, ret);
947 if (queue->data_digest)
948 nvme_tcp_ddgst_update(queue->snd_hash, page,
951 /* fully successful last write*/
952 if (last && ret == len) {
953 if (queue->data_digest) {
954 nvme_tcp_ddgst_final(queue->snd_hash,
956 req->state = NVME_TCP_SEND_DDGST;
959 nvme_tcp_done_send_req(queue);
967 static int nvme_tcp_try_send_cmd_pdu(struct nvme_tcp_request *req)
969 struct nvme_tcp_queue *queue = req->queue;
970 struct nvme_tcp_cmd_pdu *pdu = req->pdu;
971 bool inline_data = nvme_tcp_has_inline_data(req);
972 u8 hdgst = nvme_tcp_hdgst_len(queue);
973 int len = sizeof(*pdu) + hdgst - req->offset;
974 int flags = MSG_DONTWAIT;
977 if (inline_data || nvme_tcp_queue_more(queue))
978 flags |= MSG_MORE | MSG_SENDPAGE_NOTLAST;
982 if (queue->hdr_digest && !req->offset)
983 nvme_tcp_hdgst(queue->snd_hash, pdu, sizeof(*pdu));
985 ret = kernel_sendpage(queue->sock, virt_to_page(pdu),
986 offset_in_page(pdu) + req->offset, len, flags);
987 if (unlikely(ret <= 0))
993 req->state = NVME_TCP_SEND_DATA;
994 if (queue->data_digest)
995 crypto_ahash_init(queue->snd_hash);
997 nvme_tcp_done_send_req(queue);
1006 static int nvme_tcp_try_send_data_pdu(struct nvme_tcp_request *req)
1008 struct nvme_tcp_queue *queue = req->queue;
1009 struct nvme_tcp_data_pdu *pdu = req->pdu;
1010 u8 hdgst = nvme_tcp_hdgst_len(queue);
1011 int len = sizeof(*pdu) - req->offset + hdgst;
1014 if (queue->hdr_digest && !req->offset)
1015 nvme_tcp_hdgst(queue->snd_hash, pdu, sizeof(*pdu));
1017 ret = kernel_sendpage(queue->sock, virt_to_page(pdu),
1018 offset_in_page(pdu) + req->offset, len,
1019 MSG_DONTWAIT | MSG_MORE | MSG_SENDPAGE_NOTLAST);
1020 if (unlikely(ret <= 0))
1025 req->state = NVME_TCP_SEND_DATA;
1026 if (queue->data_digest)
1027 crypto_ahash_init(queue->snd_hash);
1035 static int nvme_tcp_try_send_ddgst(struct nvme_tcp_request *req)
1037 struct nvme_tcp_queue *queue = req->queue;
1039 struct msghdr msg = { .msg_flags = MSG_DONTWAIT };
1041 .iov_base = &req->ddgst + req->offset,
1042 .iov_len = NVME_TCP_DIGEST_LENGTH - req->offset
1045 if (nvme_tcp_queue_more(queue))
1046 msg.msg_flags |= MSG_MORE;
1048 msg.msg_flags |= MSG_EOR;
1050 ret = kernel_sendmsg(queue->sock, &msg, &iov, 1, iov.iov_len);
1051 if (unlikely(ret <= 0))
1054 if (req->offset + ret == NVME_TCP_DIGEST_LENGTH) {
1055 nvme_tcp_done_send_req(queue);
1063 static int nvme_tcp_try_send(struct nvme_tcp_queue *queue)
1065 struct nvme_tcp_request *req;
1068 if (!queue->request) {
1069 queue->request = nvme_tcp_fetch_request(queue);
1070 if (!queue->request)
1073 req = queue->request;
1075 if (req->state == NVME_TCP_SEND_CMD_PDU) {
1076 ret = nvme_tcp_try_send_cmd_pdu(req);
1079 if (!nvme_tcp_has_inline_data(req))
1083 if (req->state == NVME_TCP_SEND_H2C_PDU) {
1084 ret = nvme_tcp_try_send_data_pdu(req);
1089 if (req->state == NVME_TCP_SEND_DATA) {
1090 ret = nvme_tcp_try_send_data(req);
1095 if (req->state == NVME_TCP_SEND_DDGST)
1096 ret = nvme_tcp_try_send_ddgst(req);
1098 if (ret == -EAGAIN) {
1100 } else if (ret < 0) {
1101 dev_err(queue->ctrl->ctrl.device,
1102 "failed to send request %d\n", ret);
1103 if (ret != -EPIPE && ret != -ECONNRESET)
1104 nvme_tcp_fail_request(queue->request);
1105 nvme_tcp_done_send_req(queue);
1110 static int nvme_tcp_try_recv(struct nvme_tcp_queue *queue)
1112 struct socket *sock = queue->sock;
1113 struct sock *sk = sock->sk;
1114 read_descriptor_t rd_desc;
1117 rd_desc.arg.data = queue;
1121 consumed = sock->ops->read_sock(sk, &rd_desc, nvme_tcp_recv_skb);
1126 static void nvme_tcp_io_work(struct work_struct *w)
1128 struct nvme_tcp_queue *queue =
1129 container_of(w, struct nvme_tcp_queue, io_work);
1130 unsigned long deadline = jiffies + msecs_to_jiffies(1);
1133 bool pending = false;
1136 if (mutex_trylock(&queue->send_mutex)) {
1137 result = nvme_tcp_try_send(queue);
1138 mutex_unlock(&queue->send_mutex);
1141 else if (unlikely(result < 0))
1145 result = nvme_tcp_try_recv(queue);
1148 else if (unlikely(result < 0))
1154 } while (!time_after(jiffies, deadline)); /* quota is exhausted */
1156 queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
1159 static void nvme_tcp_free_crypto(struct nvme_tcp_queue *queue)
1161 struct crypto_ahash *tfm = crypto_ahash_reqtfm(queue->rcv_hash);
1163 ahash_request_free(queue->rcv_hash);
1164 ahash_request_free(queue->snd_hash);
1165 crypto_free_ahash(tfm);
1168 static int nvme_tcp_alloc_crypto(struct nvme_tcp_queue *queue)
1170 struct crypto_ahash *tfm;
1172 tfm = crypto_alloc_ahash("crc32c", 0, CRYPTO_ALG_ASYNC);
1174 return PTR_ERR(tfm);
1176 queue->snd_hash = ahash_request_alloc(tfm, GFP_KERNEL);
1177 if (!queue->snd_hash)
1179 ahash_request_set_callback(queue->snd_hash, 0, NULL, NULL);
1181 queue->rcv_hash = ahash_request_alloc(tfm, GFP_KERNEL);
1182 if (!queue->rcv_hash)
1184 ahash_request_set_callback(queue->rcv_hash, 0, NULL, NULL);
1188 ahash_request_free(queue->snd_hash);
1190 crypto_free_ahash(tfm);
1194 static void nvme_tcp_free_async_req(struct nvme_tcp_ctrl *ctrl)
1196 struct nvme_tcp_request *async = &ctrl->async_req;
1198 page_frag_free(async->pdu);
1201 static int nvme_tcp_alloc_async_req(struct nvme_tcp_ctrl *ctrl)
1203 struct nvme_tcp_queue *queue = &ctrl->queues[0];
1204 struct nvme_tcp_request *async = &ctrl->async_req;
1205 u8 hdgst = nvme_tcp_hdgst_len(queue);
1207 async->pdu = page_frag_alloc(&queue->pf_cache,
1208 sizeof(struct nvme_tcp_cmd_pdu) + hdgst,
1209 GFP_KERNEL | __GFP_ZERO);
1213 async->queue = &ctrl->queues[0];
1217 static void nvme_tcp_free_queue(struct nvme_ctrl *nctrl, int qid)
1219 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1220 struct nvme_tcp_queue *queue = &ctrl->queues[qid];
1222 if (!test_and_clear_bit(NVME_TCP_Q_ALLOCATED, &queue->flags))
1225 if (queue->hdr_digest || queue->data_digest)
1226 nvme_tcp_free_crypto(queue);
1228 sock_release(queue->sock);
1230 mutex_destroy(&queue->queue_lock);
1233 static int nvme_tcp_init_connection(struct nvme_tcp_queue *queue)
1235 struct nvme_tcp_icreq_pdu *icreq;
1236 struct nvme_tcp_icresp_pdu *icresp;
1237 struct msghdr msg = {};
1239 bool ctrl_hdgst, ctrl_ddgst;
1242 icreq = kzalloc(sizeof(*icreq), GFP_KERNEL);
1246 icresp = kzalloc(sizeof(*icresp), GFP_KERNEL);
1252 icreq->hdr.type = nvme_tcp_icreq;
1253 icreq->hdr.hlen = sizeof(*icreq);
1255 icreq->hdr.plen = cpu_to_le32(icreq->hdr.hlen);
1256 icreq->pfv = cpu_to_le16(NVME_TCP_PFV_1_0);
1257 icreq->maxr2t = 0; /* single inflight r2t supported */
1258 icreq->hpda = 0; /* no alignment constraint */
1259 if (queue->hdr_digest)
1260 icreq->digest |= NVME_TCP_HDR_DIGEST_ENABLE;
1261 if (queue->data_digest)
1262 icreq->digest |= NVME_TCP_DATA_DIGEST_ENABLE;
1264 iov.iov_base = icreq;
1265 iov.iov_len = sizeof(*icreq);
1266 ret = kernel_sendmsg(queue->sock, &msg, &iov, 1, iov.iov_len);
1270 memset(&msg, 0, sizeof(msg));
1271 iov.iov_base = icresp;
1272 iov.iov_len = sizeof(*icresp);
1273 ret = kernel_recvmsg(queue->sock, &msg, &iov, 1,
1274 iov.iov_len, msg.msg_flags);
1279 if (icresp->hdr.type != nvme_tcp_icresp) {
1280 pr_err("queue %d: bad type returned %d\n",
1281 nvme_tcp_queue_id(queue), icresp->hdr.type);
1285 if (le32_to_cpu(icresp->hdr.plen) != sizeof(*icresp)) {
1286 pr_err("queue %d: bad pdu length returned %d\n",
1287 nvme_tcp_queue_id(queue), icresp->hdr.plen);
1291 if (icresp->pfv != NVME_TCP_PFV_1_0) {
1292 pr_err("queue %d: bad pfv returned %d\n",
1293 nvme_tcp_queue_id(queue), icresp->pfv);
1297 ctrl_ddgst = !!(icresp->digest & NVME_TCP_DATA_DIGEST_ENABLE);
1298 if ((queue->data_digest && !ctrl_ddgst) ||
1299 (!queue->data_digest && ctrl_ddgst)) {
1300 pr_err("queue %d: data digest mismatch host: %s ctrl: %s\n",
1301 nvme_tcp_queue_id(queue),
1302 queue->data_digest ? "enabled" : "disabled",
1303 ctrl_ddgst ? "enabled" : "disabled");
1307 ctrl_hdgst = !!(icresp->digest & NVME_TCP_HDR_DIGEST_ENABLE);
1308 if ((queue->hdr_digest && !ctrl_hdgst) ||
1309 (!queue->hdr_digest && ctrl_hdgst)) {
1310 pr_err("queue %d: header digest mismatch host: %s ctrl: %s\n",
1311 nvme_tcp_queue_id(queue),
1312 queue->hdr_digest ? "enabled" : "disabled",
1313 ctrl_hdgst ? "enabled" : "disabled");
1317 if (icresp->cpda != 0) {
1318 pr_err("queue %d: unsupported cpda returned %d\n",
1319 nvme_tcp_queue_id(queue), icresp->cpda);
1331 static bool nvme_tcp_admin_queue(struct nvme_tcp_queue *queue)
1333 return nvme_tcp_queue_id(queue) == 0;
1336 static bool nvme_tcp_default_queue(struct nvme_tcp_queue *queue)
1338 struct nvme_tcp_ctrl *ctrl = queue->ctrl;
1339 int qid = nvme_tcp_queue_id(queue);
1341 return !nvme_tcp_admin_queue(queue) &&
1342 qid < 1 + ctrl->io_queues[HCTX_TYPE_DEFAULT];
1345 static bool nvme_tcp_read_queue(struct nvme_tcp_queue *queue)
1347 struct nvme_tcp_ctrl *ctrl = queue->ctrl;
1348 int qid = nvme_tcp_queue_id(queue);
1350 return !nvme_tcp_admin_queue(queue) &&
1351 !nvme_tcp_default_queue(queue) &&
1352 qid < 1 + ctrl->io_queues[HCTX_TYPE_DEFAULT] +
1353 ctrl->io_queues[HCTX_TYPE_READ];
1356 static bool nvme_tcp_poll_queue(struct nvme_tcp_queue *queue)
1358 struct nvme_tcp_ctrl *ctrl = queue->ctrl;
1359 int qid = nvme_tcp_queue_id(queue);
1361 return !nvme_tcp_admin_queue(queue) &&
1362 !nvme_tcp_default_queue(queue) &&
1363 !nvme_tcp_read_queue(queue) &&
1364 qid < 1 + ctrl->io_queues[HCTX_TYPE_DEFAULT] +
1365 ctrl->io_queues[HCTX_TYPE_READ] +
1366 ctrl->io_queues[HCTX_TYPE_POLL];
1369 static void nvme_tcp_set_queue_io_cpu(struct nvme_tcp_queue *queue)
1371 struct nvme_tcp_ctrl *ctrl = queue->ctrl;
1372 int qid = nvme_tcp_queue_id(queue);
1375 if (nvme_tcp_default_queue(queue))
1377 else if (nvme_tcp_read_queue(queue))
1378 n = qid - ctrl->io_queues[HCTX_TYPE_DEFAULT] - 1;
1379 else if (nvme_tcp_poll_queue(queue))
1380 n = qid - ctrl->io_queues[HCTX_TYPE_DEFAULT] -
1381 ctrl->io_queues[HCTX_TYPE_READ] - 1;
1382 queue->io_cpu = cpumask_next_wrap(n - 1, cpu_online_mask, -1, false);
1385 static int nvme_tcp_alloc_queue(struct nvme_ctrl *nctrl,
1386 int qid, size_t queue_size)
1388 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1389 struct nvme_tcp_queue *queue = &ctrl->queues[qid];
1390 int ret, rcv_pdu_size;
1392 mutex_init(&queue->queue_lock);
1394 init_llist_head(&queue->req_list);
1395 INIT_LIST_HEAD(&queue->send_list);
1396 mutex_init(&queue->send_mutex);
1397 INIT_WORK(&queue->io_work, nvme_tcp_io_work);
1398 queue->queue_size = queue_size;
1401 queue->cmnd_capsule_len = nctrl->ioccsz * 16;
1403 queue->cmnd_capsule_len = sizeof(struct nvme_command) +
1404 NVME_TCP_ADMIN_CCSZ;
1406 ret = sock_create(ctrl->addr.ss_family, SOCK_STREAM,
1407 IPPROTO_TCP, &queue->sock);
1409 dev_err(nctrl->device,
1410 "failed to create socket: %d\n", ret);
1411 goto err_destroy_mutex;
1414 /* Single syn retry */
1415 tcp_sock_set_syncnt(queue->sock->sk, 1);
1417 /* Set TCP no delay */
1418 tcp_sock_set_nodelay(queue->sock->sk);
1421 * Cleanup whatever is sitting in the TCP transmit queue on socket
1422 * close. This is done to prevent stale data from being sent should
1423 * the network connection be restored before TCP times out.
1425 sock_no_linger(queue->sock->sk);
1427 if (so_priority > 0)
1428 sock_set_priority(queue->sock->sk, so_priority);
1430 /* Set socket type of service */
1431 if (nctrl->opts->tos >= 0)
1432 ip_sock_set_tos(queue->sock->sk, nctrl->opts->tos);
1434 /* Set 10 seconds timeout for icresp recvmsg */
1435 queue->sock->sk->sk_rcvtimeo = 10 * HZ;
1437 queue->sock->sk->sk_allocation = GFP_ATOMIC;
1438 nvme_tcp_set_queue_io_cpu(queue);
1439 queue->request = NULL;
1440 queue->data_remaining = 0;
1441 queue->ddgst_remaining = 0;
1442 queue->pdu_remaining = 0;
1443 queue->pdu_offset = 0;
1444 sk_set_memalloc(queue->sock->sk);
1446 if (nctrl->opts->mask & NVMF_OPT_HOST_TRADDR) {
1447 ret = kernel_bind(queue->sock, (struct sockaddr *)&ctrl->src_addr,
1448 sizeof(ctrl->src_addr));
1450 dev_err(nctrl->device,
1451 "failed to bind queue %d socket %d\n",
1457 queue->hdr_digest = nctrl->opts->hdr_digest;
1458 queue->data_digest = nctrl->opts->data_digest;
1459 if (queue->hdr_digest || queue->data_digest) {
1460 ret = nvme_tcp_alloc_crypto(queue);
1462 dev_err(nctrl->device,
1463 "failed to allocate queue %d crypto\n", qid);
1468 rcv_pdu_size = sizeof(struct nvme_tcp_rsp_pdu) +
1469 nvme_tcp_hdgst_len(queue);
1470 queue->pdu = kmalloc(rcv_pdu_size, GFP_KERNEL);
1476 dev_dbg(nctrl->device, "connecting queue %d\n",
1477 nvme_tcp_queue_id(queue));
1479 ret = kernel_connect(queue->sock, (struct sockaddr *)&ctrl->addr,
1480 sizeof(ctrl->addr), 0);
1482 dev_err(nctrl->device,
1483 "failed to connect socket: %d\n", ret);
1487 ret = nvme_tcp_init_connection(queue);
1489 goto err_init_connect;
1491 queue->rd_enabled = true;
1492 set_bit(NVME_TCP_Q_ALLOCATED, &queue->flags);
1493 nvme_tcp_init_recv_ctx(queue);
1495 write_lock_bh(&queue->sock->sk->sk_callback_lock);
1496 queue->sock->sk->sk_user_data = queue;
1497 queue->state_change = queue->sock->sk->sk_state_change;
1498 queue->data_ready = queue->sock->sk->sk_data_ready;
1499 queue->write_space = queue->sock->sk->sk_write_space;
1500 queue->sock->sk->sk_data_ready = nvme_tcp_data_ready;
1501 queue->sock->sk->sk_state_change = nvme_tcp_state_change;
1502 queue->sock->sk->sk_write_space = nvme_tcp_write_space;
1503 #ifdef CONFIG_NET_RX_BUSY_POLL
1504 queue->sock->sk->sk_ll_usec = 1;
1506 write_unlock_bh(&queue->sock->sk->sk_callback_lock);
1511 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
1515 if (queue->hdr_digest || queue->data_digest)
1516 nvme_tcp_free_crypto(queue);
1518 sock_release(queue->sock);
1521 mutex_destroy(&queue->queue_lock);
1525 static void nvme_tcp_restore_sock_calls(struct nvme_tcp_queue *queue)
1527 struct socket *sock = queue->sock;
1529 write_lock_bh(&sock->sk->sk_callback_lock);
1530 sock->sk->sk_user_data = NULL;
1531 sock->sk->sk_data_ready = queue->data_ready;
1532 sock->sk->sk_state_change = queue->state_change;
1533 sock->sk->sk_write_space = queue->write_space;
1534 write_unlock_bh(&sock->sk->sk_callback_lock);
1537 static void __nvme_tcp_stop_queue(struct nvme_tcp_queue *queue)
1539 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
1540 nvme_tcp_restore_sock_calls(queue);
1541 cancel_work_sync(&queue->io_work);
1544 static void nvme_tcp_stop_queue(struct nvme_ctrl *nctrl, int qid)
1546 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1547 struct nvme_tcp_queue *queue = &ctrl->queues[qid];
1549 mutex_lock(&queue->queue_lock);
1550 if (test_and_clear_bit(NVME_TCP_Q_LIVE, &queue->flags))
1551 __nvme_tcp_stop_queue(queue);
1552 mutex_unlock(&queue->queue_lock);
1555 static int nvme_tcp_start_queue(struct nvme_ctrl *nctrl, int idx)
1557 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1561 ret = nvmf_connect_io_queue(nctrl, idx, false);
1563 ret = nvmf_connect_admin_queue(nctrl);
1566 set_bit(NVME_TCP_Q_LIVE, &ctrl->queues[idx].flags);
1568 if (test_bit(NVME_TCP_Q_ALLOCATED, &ctrl->queues[idx].flags))
1569 __nvme_tcp_stop_queue(&ctrl->queues[idx]);
1570 dev_err(nctrl->device,
1571 "failed to connect queue: %d ret=%d\n", idx, ret);
1576 static struct blk_mq_tag_set *nvme_tcp_alloc_tagset(struct nvme_ctrl *nctrl,
1579 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1580 struct blk_mq_tag_set *set;
1584 set = &ctrl->admin_tag_set;
1585 memset(set, 0, sizeof(*set));
1586 set->ops = &nvme_tcp_admin_mq_ops;
1587 set->queue_depth = NVME_AQ_MQ_TAG_DEPTH;
1588 set->reserved_tags = NVMF_RESERVED_TAGS;
1589 set->numa_node = nctrl->numa_node;
1590 set->flags = BLK_MQ_F_BLOCKING;
1591 set->cmd_size = sizeof(struct nvme_tcp_request);
1592 set->driver_data = ctrl;
1593 set->nr_hw_queues = 1;
1594 set->timeout = NVME_ADMIN_TIMEOUT;
1596 set = &ctrl->tag_set;
1597 memset(set, 0, sizeof(*set));
1598 set->ops = &nvme_tcp_mq_ops;
1599 set->queue_depth = nctrl->sqsize + 1;
1600 set->reserved_tags = NVMF_RESERVED_TAGS;
1601 set->numa_node = nctrl->numa_node;
1602 set->flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_BLOCKING;
1603 set->cmd_size = sizeof(struct nvme_tcp_request);
1604 set->driver_data = ctrl;
1605 set->nr_hw_queues = nctrl->queue_count - 1;
1606 set->timeout = NVME_IO_TIMEOUT;
1607 set->nr_maps = nctrl->opts->nr_poll_queues ? HCTX_MAX_TYPES : 2;
1610 ret = blk_mq_alloc_tag_set(set);
1612 return ERR_PTR(ret);
1617 static void nvme_tcp_free_admin_queue(struct nvme_ctrl *ctrl)
1619 if (to_tcp_ctrl(ctrl)->async_req.pdu) {
1620 cancel_work_sync(&ctrl->async_event_work);
1621 nvme_tcp_free_async_req(to_tcp_ctrl(ctrl));
1622 to_tcp_ctrl(ctrl)->async_req.pdu = NULL;
1625 nvme_tcp_free_queue(ctrl, 0);
1628 static void nvme_tcp_free_io_queues(struct nvme_ctrl *ctrl)
1632 for (i = 1; i < ctrl->queue_count; i++)
1633 nvme_tcp_free_queue(ctrl, i);
1636 static void nvme_tcp_stop_io_queues(struct nvme_ctrl *ctrl)
1640 for (i = 1; i < ctrl->queue_count; i++)
1641 nvme_tcp_stop_queue(ctrl, i);
1644 static int nvme_tcp_start_io_queues(struct nvme_ctrl *ctrl)
1648 for (i = 1; i < ctrl->queue_count; i++) {
1649 ret = nvme_tcp_start_queue(ctrl, i);
1651 goto out_stop_queues;
1657 for (i--; i >= 1; i--)
1658 nvme_tcp_stop_queue(ctrl, i);
1662 static int nvme_tcp_alloc_admin_queue(struct nvme_ctrl *ctrl)
1666 ret = nvme_tcp_alloc_queue(ctrl, 0, NVME_AQ_DEPTH);
1670 ret = nvme_tcp_alloc_async_req(to_tcp_ctrl(ctrl));
1672 goto out_free_queue;
1677 nvme_tcp_free_queue(ctrl, 0);
1681 static int __nvme_tcp_alloc_io_queues(struct nvme_ctrl *ctrl)
1685 for (i = 1; i < ctrl->queue_count; i++) {
1686 ret = nvme_tcp_alloc_queue(ctrl, i,
1689 goto out_free_queues;
1695 for (i--; i >= 1; i--)
1696 nvme_tcp_free_queue(ctrl, i);
1701 static unsigned int nvme_tcp_nr_io_queues(struct nvme_ctrl *ctrl)
1703 unsigned int nr_io_queues;
1705 nr_io_queues = min(ctrl->opts->nr_io_queues, num_online_cpus());
1706 nr_io_queues += min(ctrl->opts->nr_write_queues, num_online_cpus());
1707 nr_io_queues += min(ctrl->opts->nr_poll_queues, num_online_cpus());
1709 return nr_io_queues;
1712 static void nvme_tcp_set_io_queues(struct nvme_ctrl *nctrl,
1713 unsigned int nr_io_queues)
1715 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1716 struct nvmf_ctrl_options *opts = nctrl->opts;
1718 if (opts->nr_write_queues && opts->nr_io_queues < nr_io_queues) {
1720 * separate read/write queues
1721 * hand out dedicated default queues only after we have
1722 * sufficient read queues.
1724 ctrl->io_queues[HCTX_TYPE_READ] = opts->nr_io_queues;
1725 nr_io_queues -= ctrl->io_queues[HCTX_TYPE_READ];
1726 ctrl->io_queues[HCTX_TYPE_DEFAULT] =
1727 min(opts->nr_write_queues, nr_io_queues);
1728 nr_io_queues -= ctrl->io_queues[HCTX_TYPE_DEFAULT];
1731 * shared read/write queues
1732 * either no write queues were requested, or we don't have
1733 * sufficient queue count to have dedicated default queues.
1735 ctrl->io_queues[HCTX_TYPE_DEFAULT] =
1736 min(opts->nr_io_queues, nr_io_queues);
1737 nr_io_queues -= ctrl->io_queues[HCTX_TYPE_DEFAULT];
1740 if (opts->nr_poll_queues && nr_io_queues) {
1741 /* map dedicated poll queues only if we have queues left */
1742 ctrl->io_queues[HCTX_TYPE_POLL] =
1743 min(opts->nr_poll_queues, nr_io_queues);
1747 static int nvme_tcp_alloc_io_queues(struct nvme_ctrl *ctrl)
1749 unsigned int nr_io_queues;
1752 nr_io_queues = nvme_tcp_nr_io_queues(ctrl);
1753 ret = nvme_set_queue_count(ctrl, &nr_io_queues);
1757 ctrl->queue_count = nr_io_queues + 1;
1758 if (ctrl->queue_count < 2) {
1759 dev_err(ctrl->device,
1760 "unable to set any I/O queues\n");
1764 dev_info(ctrl->device,
1765 "creating %d I/O queues.\n", nr_io_queues);
1767 nvme_tcp_set_io_queues(ctrl, nr_io_queues);
1769 return __nvme_tcp_alloc_io_queues(ctrl);
1772 static void nvme_tcp_destroy_io_queues(struct nvme_ctrl *ctrl, bool remove)
1774 nvme_tcp_stop_io_queues(ctrl);
1776 blk_cleanup_queue(ctrl->connect_q);
1777 blk_mq_free_tag_set(ctrl->tagset);
1779 nvme_tcp_free_io_queues(ctrl);
1782 static int nvme_tcp_configure_io_queues(struct nvme_ctrl *ctrl, bool new)
1786 ret = nvme_tcp_alloc_io_queues(ctrl);
1791 ctrl->tagset = nvme_tcp_alloc_tagset(ctrl, false);
1792 if (IS_ERR(ctrl->tagset)) {
1793 ret = PTR_ERR(ctrl->tagset);
1794 goto out_free_io_queues;
1797 ctrl->connect_q = blk_mq_init_queue(ctrl->tagset);
1798 if (IS_ERR(ctrl->connect_q)) {
1799 ret = PTR_ERR(ctrl->connect_q);
1800 goto out_free_tag_set;
1804 ret = nvme_tcp_start_io_queues(ctrl);
1806 goto out_cleanup_connect_q;
1809 nvme_start_queues(ctrl);
1810 if (!nvme_wait_freeze_timeout(ctrl, NVME_IO_TIMEOUT)) {
1812 * If we timed out waiting for freeze we are likely to
1813 * be stuck. Fail the controller initialization just
1817 goto out_wait_freeze_timed_out;
1819 blk_mq_update_nr_hw_queues(ctrl->tagset,
1820 ctrl->queue_count - 1);
1821 nvme_unfreeze(ctrl);
1826 out_wait_freeze_timed_out:
1827 nvme_stop_queues(ctrl);
1828 nvme_sync_io_queues(ctrl);
1829 nvme_tcp_stop_io_queues(ctrl);
1830 out_cleanup_connect_q:
1831 nvme_cancel_tagset(ctrl);
1833 blk_cleanup_queue(ctrl->connect_q);
1836 blk_mq_free_tag_set(ctrl->tagset);
1838 nvme_tcp_free_io_queues(ctrl);
1842 static void nvme_tcp_destroy_admin_queue(struct nvme_ctrl *ctrl, bool remove)
1844 nvme_tcp_stop_queue(ctrl, 0);
1846 blk_cleanup_queue(ctrl->admin_q);
1847 blk_cleanup_queue(ctrl->fabrics_q);
1848 blk_mq_free_tag_set(ctrl->admin_tagset);
1850 nvme_tcp_free_admin_queue(ctrl);
1853 static int nvme_tcp_configure_admin_queue(struct nvme_ctrl *ctrl, bool new)
1857 error = nvme_tcp_alloc_admin_queue(ctrl);
1862 ctrl->admin_tagset = nvme_tcp_alloc_tagset(ctrl, true);
1863 if (IS_ERR(ctrl->admin_tagset)) {
1864 error = PTR_ERR(ctrl->admin_tagset);
1865 goto out_free_queue;
1868 ctrl->fabrics_q = blk_mq_init_queue(ctrl->admin_tagset);
1869 if (IS_ERR(ctrl->fabrics_q)) {
1870 error = PTR_ERR(ctrl->fabrics_q);
1871 goto out_free_tagset;
1874 ctrl->admin_q = blk_mq_init_queue(ctrl->admin_tagset);
1875 if (IS_ERR(ctrl->admin_q)) {
1876 error = PTR_ERR(ctrl->admin_q);
1877 goto out_cleanup_fabrics_q;
1881 error = nvme_tcp_start_queue(ctrl, 0);
1883 goto out_cleanup_queue;
1885 error = nvme_enable_ctrl(ctrl);
1887 goto out_stop_queue;
1889 blk_mq_unquiesce_queue(ctrl->admin_q);
1891 error = nvme_init_ctrl_finish(ctrl);
1893 goto out_quiesce_queue;
1898 blk_mq_quiesce_queue(ctrl->admin_q);
1899 blk_sync_queue(ctrl->admin_q);
1901 nvme_tcp_stop_queue(ctrl, 0);
1902 nvme_cancel_admin_tagset(ctrl);
1905 blk_cleanup_queue(ctrl->admin_q);
1906 out_cleanup_fabrics_q:
1908 blk_cleanup_queue(ctrl->fabrics_q);
1911 blk_mq_free_tag_set(ctrl->admin_tagset);
1913 nvme_tcp_free_admin_queue(ctrl);
1917 static void nvme_tcp_teardown_admin_queue(struct nvme_ctrl *ctrl,
1920 blk_mq_quiesce_queue(ctrl->admin_q);
1921 blk_sync_queue(ctrl->admin_q);
1922 nvme_tcp_stop_queue(ctrl, 0);
1923 nvme_cancel_admin_tagset(ctrl);
1925 blk_mq_unquiesce_queue(ctrl->admin_q);
1926 nvme_tcp_destroy_admin_queue(ctrl, remove);
1929 static void nvme_tcp_teardown_io_queues(struct nvme_ctrl *ctrl,
1932 if (ctrl->queue_count <= 1)
1934 blk_mq_quiesce_queue(ctrl->admin_q);
1935 nvme_start_freeze(ctrl);
1936 nvme_stop_queues(ctrl);
1937 nvme_sync_io_queues(ctrl);
1938 nvme_tcp_stop_io_queues(ctrl);
1939 nvme_cancel_tagset(ctrl);
1941 nvme_start_queues(ctrl);
1942 nvme_tcp_destroy_io_queues(ctrl, remove);
1945 static void nvme_tcp_reconnect_or_remove(struct nvme_ctrl *ctrl)
1947 /* If we are resetting/deleting then do nothing */
1948 if (ctrl->state != NVME_CTRL_CONNECTING) {
1949 WARN_ON_ONCE(ctrl->state == NVME_CTRL_NEW ||
1950 ctrl->state == NVME_CTRL_LIVE);
1954 if (nvmf_should_reconnect(ctrl)) {
1955 dev_info(ctrl->device, "Reconnecting in %d seconds...\n",
1956 ctrl->opts->reconnect_delay);
1957 queue_delayed_work(nvme_wq, &to_tcp_ctrl(ctrl)->connect_work,
1958 ctrl->opts->reconnect_delay * HZ);
1960 dev_info(ctrl->device, "Removing controller...\n");
1961 nvme_delete_ctrl(ctrl);
1965 static int nvme_tcp_setup_ctrl(struct nvme_ctrl *ctrl, bool new)
1967 struct nvmf_ctrl_options *opts = ctrl->opts;
1970 ret = nvme_tcp_configure_admin_queue(ctrl, new);
1975 dev_err(ctrl->device, "icdoff is not supported!\n");
1979 if (!(ctrl->sgls & ((1 << 0) | (1 << 1)))) {
1980 dev_err(ctrl->device, "Mandatory sgls are not supported!\n");
1984 if (opts->queue_size > ctrl->sqsize + 1)
1985 dev_warn(ctrl->device,
1986 "queue_size %zu > ctrl sqsize %u, clamping down\n",
1987 opts->queue_size, ctrl->sqsize + 1);
1989 if (ctrl->sqsize + 1 > ctrl->maxcmd) {
1990 dev_warn(ctrl->device,
1991 "sqsize %u > ctrl maxcmd %u, clamping down\n",
1992 ctrl->sqsize + 1, ctrl->maxcmd);
1993 ctrl->sqsize = ctrl->maxcmd - 1;
1996 if (ctrl->queue_count > 1) {
1997 ret = nvme_tcp_configure_io_queues(ctrl, new);
2002 if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE)) {
2004 * state change failure is ok if we started ctrl delete,
2005 * unless we're during creation of a new controller to
2006 * avoid races with teardown flow.
2008 WARN_ON_ONCE(ctrl->state != NVME_CTRL_DELETING &&
2009 ctrl->state != NVME_CTRL_DELETING_NOIO);
2015 nvme_start_ctrl(ctrl);
2019 if (ctrl->queue_count > 1) {
2020 nvme_stop_queues(ctrl);
2021 nvme_sync_io_queues(ctrl);
2022 nvme_tcp_stop_io_queues(ctrl);
2023 nvme_cancel_tagset(ctrl);
2024 nvme_tcp_destroy_io_queues(ctrl, new);
2027 blk_mq_quiesce_queue(ctrl->admin_q);
2028 blk_sync_queue(ctrl->admin_q);
2029 nvme_tcp_stop_queue(ctrl, 0);
2030 nvme_cancel_admin_tagset(ctrl);
2031 nvme_tcp_destroy_admin_queue(ctrl, new);
2035 static void nvme_tcp_reconnect_ctrl_work(struct work_struct *work)
2037 struct nvme_tcp_ctrl *tcp_ctrl = container_of(to_delayed_work(work),
2038 struct nvme_tcp_ctrl, connect_work);
2039 struct nvme_ctrl *ctrl = &tcp_ctrl->ctrl;
2041 ++ctrl->nr_reconnects;
2043 if (nvme_tcp_setup_ctrl(ctrl, false))
2046 dev_info(ctrl->device, "Successfully reconnected (%d attempt)\n",
2047 ctrl->nr_reconnects);
2049 ctrl->nr_reconnects = 0;
2054 dev_info(ctrl->device, "Failed reconnect attempt %d\n",
2055 ctrl->nr_reconnects);
2056 nvme_tcp_reconnect_or_remove(ctrl);
2059 static void nvme_tcp_error_recovery_work(struct work_struct *work)
2061 struct nvme_tcp_ctrl *tcp_ctrl = container_of(work,
2062 struct nvme_tcp_ctrl, err_work);
2063 struct nvme_ctrl *ctrl = &tcp_ctrl->ctrl;
2065 nvme_stop_keep_alive(ctrl);
2066 nvme_tcp_teardown_io_queues(ctrl, false);
2067 /* unquiesce to fail fast pending requests */
2068 nvme_start_queues(ctrl);
2069 nvme_tcp_teardown_admin_queue(ctrl, false);
2070 blk_mq_unquiesce_queue(ctrl->admin_q);
2072 if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_CONNECTING)) {
2073 /* state change failure is ok if we started ctrl delete */
2074 WARN_ON_ONCE(ctrl->state != NVME_CTRL_DELETING &&
2075 ctrl->state != NVME_CTRL_DELETING_NOIO);
2079 nvme_tcp_reconnect_or_remove(ctrl);
2082 static void nvme_tcp_teardown_ctrl(struct nvme_ctrl *ctrl, bool shutdown)
2084 cancel_work_sync(&to_tcp_ctrl(ctrl)->err_work);
2085 cancel_delayed_work_sync(&to_tcp_ctrl(ctrl)->connect_work);
2087 nvme_tcp_teardown_io_queues(ctrl, shutdown);
2088 blk_mq_quiesce_queue(ctrl->admin_q);
2090 nvme_shutdown_ctrl(ctrl);
2092 nvme_disable_ctrl(ctrl);
2093 nvme_tcp_teardown_admin_queue(ctrl, shutdown);
2096 static void nvme_tcp_delete_ctrl(struct nvme_ctrl *ctrl)
2098 nvme_tcp_teardown_ctrl(ctrl, true);
2101 static void nvme_reset_ctrl_work(struct work_struct *work)
2103 struct nvme_ctrl *ctrl =
2104 container_of(work, struct nvme_ctrl, reset_work);
2106 nvme_stop_ctrl(ctrl);
2107 nvme_tcp_teardown_ctrl(ctrl, false);
2109 if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_CONNECTING)) {
2110 /* state change failure is ok if we started ctrl delete */
2111 WARN_ON_ONCE(ctrl->state != NVME_CTRL_DELETING &&
2112 ctrl->state != NVME_CTRL_DELETING_NOIO);
2116 if (nvme_tcp_setup_ctrl(ctrl, false))
2122 ++ctrl->nr_reconnects;
2123 nvme_tcp_reconnect_or_remove(ctrl);
2126 static void nvme_tcp_free_ctrl(struct nvme_ctrl *nctrl)
2128 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
2130 if (list_empty(&ctrl->list))
2133 mutex_lock(&nvme_tcp_ctrl_mutex);
2134 list_del(&ctrl->list);
2135 mutex_unlock(&nvme_tcp_ctrl_mutex);
2137 nvmf_free_options(nctrl->opts);
2139 kfree(ctrl->queues);
2143 static void nvme_tcp_set_sg_null(struct nvme_command *c)
2145 struct nvme_sgl_desc *sg = &c->common.dptr.sgl;
2149 sg->type = (NVME_TRANSPORT_SGL_DATA_DESC << 4) |
2150 NVME_SGL_FMT_TRANSPORT_A;
2153 static void nvme_tcp_set_sg_inline(struct nvme_tcp_queue *queue,
2154 struct nvme_command *c, u32 data_len)
2156 struct nvme_sgl_desc *sg = &c->common.dptr.sgl;
2158 sg->addr = cpu_to_le64(queue->ctrl->ctrl.icdoff);
2159 sg->length = cpu_to_le32(data_len);
2160 sg->type = (NVME_SGL_FMT_DATA_DESC << 4) | NVME_SGL_FMT_OFFSET;
2163 static void nvme_tcp_set_sg_host_data(struct nvme_command *c,
2166 struct nvme_sgl_desc *sg = &c->common.dptr.sgl;
2169 sg->length = cpu_to_le32(data_len);
2170 sg->type = (NVME_TRANSPORT_SGL_DATA_DESC << 4) |
2171 NVME_SGL_FMT_TRANSPORT_A;
2174 static void nvme_tcp_submit_async_event(struct nvme_ctrl *arg)
2176 struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(arg);
2177 struct nvme_tcp_queue *queue = &ctrl->queues[0];
2178 struct nvme_tcp_cmd_pdu *pdu = ctrl->async_req.pdu;
2179 struct nvme_command *cmd = &pdu->cmd;
2180 u8 hdgst = nvme_tcp_hdgst_len(queue);
2182 memset(pdu, 0, sizeof(*pdu));
2183 pdu->hdr.type = nvme_tcp_cmd;
2184 if (queue->hdr_digest)
2185 pdu->hdr.flags |= NVME_TCP_F_HDGST;
2186 pdu->hdr.hlen = sizeof(*pdu);
2187 pdu->hdr.plen = cpu_to_le32(pdu->hdr.hlen + hdgst);
2189 cmd->common.opcode = nvme_admin_async_event;
2190 cmd->common.command_id = NVME_AQ_BLK_MQ_DEPTH;
2191 cmd->common.flags |= NVME_CMD_SGL_METABUF;
2192 nvme_tcp_set_sg_null(cmd);
2194 ctrl->async_req.state = NVME_TCP_SEND_CMD_PDU;
2195 ctrl->async_req.offset = 0;
2196 ctrl->async_req.curr_bio = NULL;
2197 ctrl->async_req.data_len = 0;
2199 nvme_tcp_queue_request(&ctrl->async_req, true, true);
2202 static void nvme_tcp_complete_timed_out(struct request *rq)
2204 struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
2205 struct nvme_ctrl *ctrl = &req->queue->ctrl->ctrl;
2207 nvme_tcp_stop_queue(ctrl, nvme_tcp_queue_id(req->queue));
2208 if (blk_mq_request_started(rq) && !blk_mq_request_completed(rq)) {
2209 nvme_req(rq)->status = NVME_SC_HOST_ABORTED_CMD;
2210 blk_mq_complete_request(rq);
2214 static enum blk_eh_timer_return
2215 nvme_tcp_timeout(struct request *rq, bool reserved)
2217 struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
2218 struct nvme_ctrl *ctrl = &req->queue->ctrl->ctrl;
2219 struct nvme_tcp_cmd_pdu *pdu = req->pdu;
2221 dev_warn(ctrl->device,
2222 "queue %d: timeout request %#x type %d\n",
2223 nvme_tcp_queue_id(req->queue), rq->tag, pdu->hdr.type);
2225 if (ctrl->state != NVME_CTRL_LIVE) {
2227 * If we are resetting, connecting or deleting we should
2228 * complete immediately because we may block controller
2229 * teardown or setup sequence
2230 * - ctrl disable/shutdown fabrics requests
2231 * - connect requests
2232 * - initialization admin requests
2233 * - I/O requests that entered after unquiescing and
2234 * the controller stopped responding
2236 * All other requests should be cancelled by the error
2237 * recovery work, so it's fine that we fail it here.
2239 nvme_tcp_complete_timed_out(rq);
2244 * LIVE state should trigger the normal error recovery which will
2245 * handle completing this request.
2247 nvme_tcp_error_recovery(ctrl);
2248 return BLK_EH_RESET_TIMER;
2251 static blk_status_t nvme_tcp_map_data(struct nvme_tcp_queue *queue,
2254 struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
2255 struct nvme_tcp_cmd_pdu *pdu = req->pdu;
2256 struct nvme_command *c = &pdu->cmd;
2258 c->common.flags |= NVME_CMD_SGL_METABUF;
2260 if (!blk_rq_nr_phys_segments(rq))
2261 nvme_tcp_set_sg_null(c);
2262 else if (rq_data_dir(rq) == WRITE &&
2263 req->data_len <= nvme_tcp_inline_data_size(queue))
2264 nvme_tcp_set_sg_inline(queue, c, req->data_len);
2266 nvme_tcp_set_sg_host_data(c, req->data_len);
2271 static blk_status_t nvme_tcp_setup_cmd_pdu(struct nvme_ns *ns,
2274 struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
2275 struct nvme_tcp_cmd_pdu *pdu = req->pdu;
2276 struct nvme_tcp_queue *queue = req->queue;
2277 u8 hdgst = nvme_tcp_hdgst_len(queue), ddgst = 0;
2280 ret = nvme_setup_cmd(ns, rq);
2284 req->state = NVME_TCP_SEND_CMD_PDU;
2289 req->data_len = blk_rq_nr_phys_segments(rq) ?
2290 blk_rq_payload_bytes(rq) : 0;
2291 req->curr_bio = rq->bio;
2292 if (req->curr_bio && req->data_len)
2293 nvme_tcp_init_iter(req, rq_data_dir(rq));
2295 if (rq_data_dir(rq) == WRITE &&
2296 req->data_len <= nvme_tcp_inline_data_size(queue))
2297 req->pdu_len = req->data_len;
2299 pdu->hdr.type = nvme_tcp_cmd;
2301 if (queue->hdr_digest)
2302 pdu->hdr.flags |= NVME_TCP_F_HDGST;
2303 if (queue->data_digest && req->pdu_len) {
2304 pdu->hdr.flags |= NVME_TCP_F_DDGST;
2305 ddgst = nvme_tcp_ddgst_len(queue);
2307 pdu->hdr.hlen = sizeof(*pdu);
2308 pdu->hdr.pdo = req->pdu_len ? pdu->hdr.hlen + hdgst : 0;
2310 cpu_to_le32(pdu->hdr.hlen + hdgst + req->pdu_len + ddgst);
2312 ret = nvme_tcp_map_data(queue, rq);
2313 if (unlikely(ret)) {
2314 nvme_cleanup_cmd(rq);
2315 dev_err(queue->ctrl->ctrl.device,
2316 "Failed to map data (%d)\n", ret);
2323 static void nvme_tcp_commit_rqs(struct blk_mq_hw_ctx *hctx)
2325 struct nvme_tcp_queue *queue = hctx->driver_data;
2327 if (!llist_empty(&queue->req_list))
2328 queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
2331 static blk_status_t nvme_tcp_queue_rq(struct blk_mq_hw_ctx *hctx,
2332 const struct blk_mq_queue_data *bd)
2334 struct nvme_ns *ns = hctx->queue->queuedata;
2335 struct nvme_tcp_queue *queue = hctx->driver_data;
2336 struct request *rq = bd->rq;
2337 struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
2338 bool queue_ready = test_bit(NVME_TCP_Q_LIVE, &queue->flags);
2341 if (!nvmf_check_ready(&queue->ctrl->ctrl, rq, queue_ready))
2342 return nvmf_fail_nonready_command(&queue->ctrl->ctrl, rq);
2344 ret = nvme_tcp_setup_cmd_pdu(ns, rq);
2348 blk_mq_start_request(rq);
2350 nvme_tcp_queue_request(req, true, bd->last);
2355 static int nvme_tcp_map_queues(struct blk_mq_tag_set *set)
2357 struct nvme_tcp_ctrl *ctrl = set->driver_data;
2358 struct nvmf_ctrl_options *opts = ctrl->ctrl.opts;
2360 if (opts->nr_write_queues && ctrl->io_queues[HCTX_TYPE_READ]) {
2361 /* separate read/write queues */
2362 set->map[HCTX_TYPE_DEFAULT].nr_queues =
2363 ctrl->io_queues[HCTX_TYPE_DEFAULT];
2364 set->map[HCTX_TYPE_DEFAULT].queue_offset = 0;
2365 set->map[HCTX_TYPE_READ].nr_queues =
2366 ctrl->io_queues[HCTX_TYPE_READ];
2367 set->map[HCTX_TYPE_READ].queue_offset =
2368 ctrl->io_queues[HCTX_TYPE_DEFAULT];
2370 /* shared read/write queues */
2371 set->map[HCTX_TYPE_DEFAULT].nr_queues =
2372 ctrl->io_queues[HCTX_TYPE_DEFAULT];
2373 set->map[HCTX_TYPE_DEFAULT].queue_offset = 0;
2374 set->map[HCTX_TYPE_READ].nr_queues =
2375 ctrl->io_queues[HCTX_TYPE_DEFAULT];
2376 set->map[HCTX_TYPE_READ].queue_offset = 0;
2378 blk_mq_map_queues(&set->map[HCTX_TYPE_DEFAULT]);
2379 blk_mq_map_queues(&set->map[HCTX_TYPE_READ]);
2381 if (opts->nr_poll_queues && ctrl->io_queues[HCTX_TYPE_POLL]) {
2382 /* map dedicated poll queues only if we have queues left */
2383 set->map[HCTX_TYPE_POLL].nr_queues =
2384 ctrl->io_queues[HCTX_TYPE_POLL];
2385 set->map[HCTX_TYPE_POLL].queue_offset =
2386 ctrl->io_queues[HCTX_TYPE_DEFAULT] +
2387 ctrl->io_queues[HCTX_TYPE_READ];
2388 blk_mq_map_queues(&set->map[HCTX_TYPE_POLL]);
2391 dev_info(ctrl->ctrl.device,
2392 "mapped %d/%d/%d default/read/poll queues.\n",
2393 ctrl->io_queues[HCTX_TYPE_DEFAULT],
2394 ctrl->io_queues[HCTX_TYPE_READ],
2395 ctrl->io_queues[HCTX_TYPE_POLL]);
2400 static int nvme_tcp_poll(struct blk_mq_hw_ctx *hctx)
2402 struct nvme_tcp_queue *queue = hctx->driver_data;
2403 struct sock *sk = queue->sock->sk;
2405 if (!test_bit(NVME_TCP_Q_LIVE, &queue->flags))
2408 set_bit(NVME_TCP_Q_POLLING, &queue->flags);
2409 if (sk_can_busy_loop(sk) && skb_queue_empty_lockless(&sk->sk_receive_queue))
2410 sk_busy_loop(sk, true);
2411 nvme_tcp_try_recv(queue);
2412 clear_bit(NVME_TCP_Q_POLLING, &queue->flags);
2413 return queue->nr_cqe;
2416 static const struct blk_mq_ops nvme_tcp_mq_ops = {
2417 .queue_rq = nvme_tcp_queue_rq,
2418 .commit_rqs = nvme_tcp_commit_rqs,
2419 .complete = nvme_complete_rq,
2420 .init_request = nvme_tcp_init_request,
2421 .exit_request = nvme_tcp_exit_request,
2422 .init_hctx = nvme_tcp_init_hctx,
2423 .timeout = nvme_tcp_timeout,
2424 .map_queues = nvme_tcp_map_queues,
2425 .poll = nvme_tcp_poll,
2428 static const struct blk_mq_ops nvme_tcp_admin_mq_ops = {
2429 .queue_rq = nvme_tcp_queue_rq,
2430 .complete = nvme_complete_rq,
2431 .init_request = nvme_tcp_init_request,
2432 .exit_request = nvme_tcp_exit_request,
2433 .init_hctx = nvme_tcp_init_admin_hctx,
2434 .timeout = nvme_tcp_timeout,
2437 static const struct nvme_ctrl_ops nvme_tcp_ctrl_ops = {
2439 .module = THIS_MODULE,
2440 .flags = NVME_F_FABRICS,
2441 .reg_read32 = nvmf_reg_read32,
2442 .reg_read64 = nvmf_reg_read64,
2443 .reg_write32 = nvmf_reg_write32,
2444 .free_ctrl = nvme_tcp_free_ctrl,
2445 .submit_async_event = nvme_tcp_submit_async_event,
2446 .delete_ctrl = nvme_tcp_delete_ctrl,
2447 .get_address = nvmf_get_address,
2451 nvme_tcp_existing_controller(struct nvmf_ctrl_options *opts)
2453 struct nvme_tcp_ctrl *ctrl;
2456 mutex_lock(&nvme_tcp_ctrl_mutex);
2457 list_for_each_entry(ctrl, &nvme_tcp_ctrl_list, list) {
2458 found = nvmf_ip_options_match(&ctrl->ctrl, opts);
2462 mutex_unlock(&nvme_tcp_ctrl_mutex);
2467 static struct nvme_ctrl *nvme_tcp_create_ctrl(struct device *dev,
2468 struct nvmf_ctrl_options *opts)
2470 struct nvme_tcp_ctrl *ctrl;
2473 ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
2475 return ERR_PTR(-ENOMEM);
2477 INIT_LIST_HEAD(&ctrl->list);
2478 ctrl->ctrl.opts = opts;
2479 ctrl->ctrl.queue_count = opts->nr_io_queues + opts->nr_write_queues +
2480 opts->nr_poll_queues + 1;
2481 ctrl->ctrl.sqsize = opts->queue_size - 1;
2482 ctrl->ctrl.kato = opts->kato;
2484 INIT_DELAYED_WORK(&ctrl->connect_work,
2485 nvme_tcp_reconnect_ctrl_work);
2486 INIT_WORK(&ctrl->err_work, nvme_tcp_error_recovery_work);
2487 INIT_WORK(&ctrl->ctrl.reset_work, nvme_reset_ctrl_work);
2489 if (!(opts->mask & NVMF_OPT_TRSVCID)) {
2491 kstrdup(__stringify(NVME_TCP_DISC_PORT), GFP_KERNEL);
2492 if (!opts->trsvcid) {
2496 opts->mask |= NVMF_OPT_TRSVCID;
2499 ret = inet_pton_with_scope(&init_net, AF_UNSPEC,
2500 opts->traddr, opts->trsvcid, &ctrl->addr);
2502 pr_err("malformed address passed: %s:%s\n",
2503 opts->traddr, opts->trsvcid);
2507 if (opts->mask & NVMF_OPT_HOST_TRADDR) {
2508 ret = inet_pton_with_scope(&init_net, AF_UNSPEC,
2509 opts->host_traddr, NULL, &ctrl->src_addr);
2511 pr_err("malformed src address passed: %s\n",
2517 if (!opts->duplicate_connect && nvme_tcp_existing_controller(opts)) {
2522 ctrl->queues = kcalloc(ctrl->ctrl.queue_count, sizeof(*ctrl->queues),
2524 if (!ctrl->queues) {
2529 ret = nvme_init_ctrl(&ctrl->ctrl, dev, &nvme_tcp_ctrl_ops, 0);
2531 goto out_kfree_queues;
2533 if (!nvme_change_ctrl_state(&ctrl->ctrl, NVME_CTRL_CONNECTING)) {
2536 goto out_uninit_ctrl;
2539 ret = nvme_tcp_setup_ctrl(&ctrl->ctrl, true);
2541 goto out_uninit_ctrl;
2543 dev_info(ctrl->ctrl.device, "new ctrl: NQN \"%s\", addr %pISp\n",
2544 ctrl->ctrl.opts->subsysnqn, &ctrl->addr);
2546 mutex_lock(&nvme_tcp_ctrl_mutex);
2547 list_add_tail(&ctrl->list, &nvme_tcp_ctrl_list);
2548 mutex_unlock(&nvme_tcp_ctrl_mutex);
2553 nvme_uninit_ctrl(&ctrl->ctrl);
2554 nvme_put_ctrl(&ctrl->ctrl);
2557 return ERR_PTR(ret);
2559 kfree(ctrl->queues);
2562 return ERR_PTR(ret);
2565 static struct nvmf_transport_ops nvme_tcp_transport = {
2567 .module = THIS_MODULE,
2568 .required_opts = NVMF_OPT_TRADDR,
2569 .allowed_opts = NVMF_OPT_TRSVCID | NVMF_OPT_RECONNECT_DELAY |
2570 NVMF_OPT_HOST_TRADDR | NVMF_OPT_CTRL_LOSS_TMO |
2571 NVMF_OPT_HDR_DIGEST | NVMF_OPT_DATA_DIGEST |
2572 NVMF_OPT_NR_WRITE_QUEUES | NVMF_OPT_NR_POLL_QUEUES |
2574 .create_ctrl = nvme_tcp_create_ctrl,
2577 static int __init nvme_tcp_init_module(void)
2579 nvme_tcp_wq = alloc_workqueue("nvme_tcp_wq",
2580 WQ_MEM_RECLAIM | WQ_HIGHPRI, 0);
2584 nvmf_register_transport(&nvme_tcp_transport);
2588 static void __exit nvme_tcp_cleanup_module(void)
2590 struct nvme_tcp_ctrl *ctrl;
2592 nvmf_unregister_transport(&nvme_tcp_transport);
2594 mutex_lock(&nvme_tcp_ctrl_mutex);
2595 list_for_each_entry(ctrl, &nvme_tcp_ctrl_list, list)
2596 nvme_delete_ctrl(&ctrl->ctrl);
2597 mutex_unlock(&nvme_tcp_ctrl_mutex);
2598 flush_workqueue(nvme_delete_wq);
2600 destroy_workqueue(nvme_tcp_wq);
2603 module_init(nvme_tcp_init_module);
2604 module_exit(nvme_tcp_cleanup_module);
2606 MODULE_LICENSE("GPL v2");