1 // SPDX-License-Identifier: GPL-2.0
3 * NVMe over Fabrics TCP target.
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/key.h>
12 #include <linux/nvme-tcp.h>
13 #include <linux/nvme-keyring.h>
17 #include <net/tls_prot.h>
18 #include <net/handshake.h>
19 #include <linux/inet.h>
20 #include <linux/llist.h>
21 #include <crypto/hash.h>
22 #include <trace/events/sock.h>
26 #define NVMET_TCP_DEF_INLINE_DATA_SIZE (4 * PAGE_SIZE)
27 #define NVMET_TCP_MAXH2CDATA 0x400000 /* 16M arbitrary limit */
28 #define NVMET_TCP_BACKLOG 128
30 static int param_store_val(const char *str, int *val, int min, int max)
34 ret = kstrtoint(str, 10, &new_val);
38 if (new_val < min || new_val > max)
45 static int set_params(const char *str, const struct kernel_param *kp)
47 return param_store_val(str, kp->arg, 0, INT_MAX);
50 static const struct kernel_param_ops set_param_ops = {
55 /* Define the socket priority to use for connections were it is desirable
56 * that the NIC consider performing optimized packet processing or filtering.
57 * A non-zero value being sufficient to indicate general consideration of any
58 * possible optimization. Making it a module param allows for alternative
59 * values that may be unique for some NIC implementations.
61 static int so_priority;
62 device_param_cb(so_priority, &set_param_ops, &so_priority, 0644);
63 MODULE_PARM_DESC(so_priority, "nvmet tcp socket optimize priority: Default 0");
65 /* Define a time period (in usecs) that io_work() shall sample an activated
66 * queue before determining it to be idle. This optional module behavior
67 * can enable NIC solutions that support socket optimized packet processing
68 * using advanced interrupt moderation techniques.
70 static int idle_poll_period_usecs;
71 device_param_cb(idle_poll_period_usecs, &set_param_ops,
72 &idle_poll_period_usecs, 0644);
73 MODULE_PARM_DESC(idle_poll_period_usecs,
74 "nvmet tcp io_work poll till idle time period in usecs: Default 0");
76 #ifdef CONFIG_NVME_TARGET_TCP_TLS
78 * TLS handshake timeout
80 static int tls_handshake_timeout = 10;
81 module_param(tls_handshake_timeout, int, 0644);
82 MODULE_PARM_DESC(tls_handshake_timeout,
83 "nvme TLS handshake timeout in seconds (default 10)");
86 #define NVMET_TCP_RECV_BUDGET 8
87 #define NVMET_TCP_SEND_BUDGET 8
88 #define NVMET_TCP_IO_WORK_BUDGET 64
90 enum nvmet_tcp_send_state {
91 NVMET_TCP_SEND_DATA_PDU,
95 NVMET_TCP_SEND_RESPONSE
98 enum nvmet_tcp_recv_state {
101 NVMET_TCP_RECV_DDGST,
106 NVMET_TCP_F_INIT_FAILED = (1 << 0),
109 struct nvmet_tcp_cmd {
110 struct nvmet_tcp_queue *queue;
111 struct nvmet_req req;
113 struct nvme_tcp_cmd_pdu *cmd_pdu;
114 struct nvme_tcp_rsp_pdu *rsp_pdu;
115 struct nvme_tcp_data_pdu *data_pdu;
116 struct nvme_tcp_r2t_pdu *r2t_pdu;
124 char recv_cbuf[CMSG_LEN(sizeof(char))];
125 struct msghdr recv_msg;
129 struct list_head entry;
130 struct llist_node lentry;
134 struct scatterlist *cur_sg;
135 enum nvmet_tcp_send_state state;
141 enum nvmet_tcp_queue_state {
142 NVMET_TCP_Q_CONNECTING,
143 NVMET_TCP_Q_TLS_HANDSHAKE,
145 NVMET_TCP_Q_DISCONNECTING,
149 struct nvmet_tcp_queue {
151 struct nvmet_tcp_port *port;
152 struct work_struct io_work;
153 struct nvmet_cq nvme_cq;
154 struct nvmet_sq nvme_sq;
158 struct nvmet_tcp_cmd *cmds;
159 unsigned int nr_cmds;
160 struct list_head free_list;
161 struct llist_head resp_list;
162 struct list_head resp_send_list;
164 struct nvmet_tcp_cmd *snd_cmd;
169 enum nvmet_tcp_recv_state rcv_state;
170 struct nvmet_tcp_cmd *cmd;
171 union nvme_tcp_pdu pdu;
176 struct ahash_request *snd_hash;
177 struct ahash_request *rcv_hash;
180 key_serial_t tls_pskid;
181 struct delayed_work tls_handshake_tmo_work;
183 unsigned long poll_end;
185 spinlock_t state_lock;
186 enum nvmet_tcp_queue_state state;
188 struct sockaddr_storage sockaddr;
189 struct sockaddr_storage sockaddr_peer;
190 struct work_struct release_work;
193 struct list_head queue_list;
195 struct nvmet_tcp_cmd connect;
197 struct page_frag_cache pf_cache;
199 void (*data_ready)(struct sock *);
200 void (*state_change)(struct sock *);
201 void (*write_space)(struct sock *);
204 struct nvmet_tcp_port {
206 struct work_struct accept_work;
207 struct nvmet_port *nport;
208 struct sockaddr_storage addr;
209 void (*data_ready)(struct sock *);
212 static DEFINE_IDA(nvmet_tcp_queue_ida);
213 static LIST_HEAD(nvmet_tcp_queue_list);
214 static DEFINE_MUTEX(nvmet_tcp_queue_mutex);
216 static struct workqueue_struct *nvmet_tcp_wq;
217 static const struct nvmet_fabrics_ops nvmet_tcp_ops;
218 static void nvmet_tcp_free_cmd(struct nvmet_tcp_cmd *c);
219 static void nvmet_tcp_free_cmd_buffers(struct nvmet_tcp_cmd *cmd);
221 static inline u16 nvmet_tcp_cmd_tag(struct nvmet_tcp_queue *queue,
222 struct nvmet_tcp_cmd *cmd)
224 if (unlikely(!queue->nr_cmds)) {
225 /* We didn't allocate cmds yet, send 0xffff */
229 return cmd - queue->cmds;
232 static inline bool nvmet_tcp_has_data_in(struct nvmet_tcp_cmd *cmd)
234 return nvme_is_write(cmd->req.cmd) &&
235 cmd->rbytes_done < cmd->req.transfer_len;
238 static inline bool nvmet_tcp_need_data_in(struct nvmet_tcp_cmd *cmd)
240 return nvmet_tcp_has_data_in(cmd) && !cmd->req.cqe->status;
243 static inline bool nvmet_tcp_need_data_out(struct nvmet_tcp_cmd *cmd)
245 return !nvme_is_write(cmd->req.cmd) &&
246 cmd->req.transfer_len > 0 &&
247 !cmd->req.cqe->status;
250 static inline bool nvmet_tcp_has_inline_data(struct nvmet_tcp_cmd *cmd)
252 return nvme_is_write(cmd->req.cmd) && cmd->pdu_len &&
256 static inline struct nvmet_tcp_cmd *
257 nvmet_tcp_get_cmd(struct nvmet_tcp_queue *queue)
259 struct nvmet_tcp_cmd *cmd;
261 cmd = list_first_entry_or_null(&queue->free_list,
262 struct nvmet_tcp_cmd, entry);
265 list_del_init(&cmd->entry);
267 cmd->rbytes_done = cmd->wbytes_done = 0;
275 static inline void nvmet_tcp_put_cmd(struct nvmet_tcp_cmd *cmd)
277 if (unlikely(cmd == &cmd->queue->connect))
280 list_add_tail(&cmd->entry, &cmd->queue->free_list);
283 static inline int queue_cpu(struct nvmet_tcp_queue *queue)
285 return queue->sock->sk->sk_incoming_cpu;
288 static inline u8 nvmet_tcp_hdgst_len(struct nvmet_tcp_queue *queue)
290 return queue->hdr_digest ? NVME_TCP_DIGEST_LENGTH : 0;
293 static inline u8 nvmet_tcp_ddgst_len(struct nvmet_tcp_queue *queue)
295 return queue->data_digest ? NVME_TCP_DIGEST_LENGTH : 0;
298 static inline void nvmet_tcp_hdgst(struct ahash_request *hash,
299 void *pdu, size_t len)
301 struct scatterlist sg;
303 sg_init_one(&sg, pdu, len);
304 ahash_request_set_crypt(hash, &sg, pdu + len, len);
305 crypto_ahash_digest(hash);
308 static int nvmet_tcp_verify_hdgst(struct nvmet_tcp_queue *queue,
309 void *pdu, size_t len)
311 struct nvme_tcp_hdr *hdr = pdu;
315 if (unlikely(!(hdr->flags & NVME_TCP_F_HDGST))) {
316 pr_err("queue %d: header digest enabled but no header digest\n",
321 recv_digest = *(__le32 *)(pdu + hdr->hlen);
322 nvmet_tcp_hdgst(queue->rcv_hash, pdu, len);
323 exp_digest = *(__le32 *)(pdu + hdr->hlen);
324 if (recv_digest != exp_digest) {
325 pr_err("queue %d: header digest error: recv %#x expected %#x\n",
326 queue->idx, le32_to_cpu(recv_digest),
327 le32_to_cpu(exp_digest));
334 static int nvmet_tcp_check_ddgst(struct nvmet_tcp_queue *queue, void *pdu)
336 struct nvme_tcp_hdr *hdr = pdu;
337 u8 digest_len = nvmet_tcp_hdgst_len(queue);
340 len = le32_to_cpu(hdr->plen) - hdr->hlen -
341 (hdr->flags & NVME_TCP_F_HDGST ? digest_len : 0);
343 if (unlikely(len && !(hdr->flags & NVME_TCP_F_DDGST))) {
344 pr_err("queue %d: data digest flag is cleared\n", queue->idx);
351 static void nvmet_tcp_free_cmd_buffers(struct nvmet_tcp_cmd *cmd)
354 sgl_free(cmd->req.sg);
359 static void nvmet_tcp_build_pdu_iovec(struct nvmet_tcp_cmd *cmd)
361 struct bio_vec *iov = cmd->iov;
362 struct scatterlist *sg;
363 u32 length, offset, sg_offset;
366 length = cmd->pdu_len;
367 nr_pages = DIV_ROUND_UP(length, PAGE_SIZE);
368 offset = cmd->rbytes_done;
369 cmd->sg_idx = offset / PAGE_SIZE;
370 sg_offset = offset % PAGE_SIZE;
371 sg = &cmd->req.sg[cmd->sg_idx];
374 u32 iov_len = min_t(u32, length, sg->length - sg_offset);
376 bvec_set_page(iov, sg_page(sg), iov_len,
377 sg->offset + sg_offset);
385 iov_iter_bvec(&cmd->recv_msg.msg_iter, ITER_DEST, cmd->iov,
386 nr_pages, cmd->pdu_len);
389 static void nvmet_tcp_fatal_error(struct nvmet_tcp_queue *queue)
391 queue->rcv_state = NVMET_TCP_RECV_ERR;
392 if (queue->nvme_sq.ctrl)
393 nvmet_ctrl_fatal_error(queue->nvme_sq.ctrl);
395 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
398 static void nvmet_tcp_socket_error(struct nvmet_tcp_queue *queue, int status)
400 queue->rcv_state = NVMET_TCP_RECV_ERR;
401 if (status == -EPIPE || status == -ECONNRESET)
402 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
404 nvmet_tcp_fatal_error(queue);
407 static int nvmet_tcp_map_data(struct nvmet_tcp_cmd *cmd)
409 struct nvme_sgl_desc *sgl = &cmd->req.cmd->common.dptr.sgl;
410 u32 len = le32_to_cpu(sgl->length);
415 if (sgl->type == ((NVME_SGL_FMT_DATA_DESC << 4) |
416 NVME_SGL_FMT_OFFSET)) {
417 if (!nvme_is_write(cmd->req.cmd))
418 return NVME_SC_INVALID_FIELD | NVME_SC_DNR;
420 if (len > cmd->req.port->inline_data_size)
421 return NVME_SC_SGL_INVALID_OFFSET | NVME_SC_DNR;
424 cmd->req.transfer_len += len;
426 cmd->req.sg = sgl_alloc(len, GFP_KERNEL, &cmd->req.sg_cnt);
428 return NVME_SC_INTERNAL;
429 cmd->cur_sg = cmd->req.sg;
431 if (nvmet_tcp_has_data_in(cmd)) {
432 cmd->iov = kmalloc_array(cmd->req.sg_cnt,
433 sizeof(*cmd->iov), GFP_KERNEL);
440 nvmet_tcp_free_cmd_buffers(cmd);
441 return NVME_SC_INTERNAL;
444 static void nvmet_tcp_calc_ddgst(struct ahash_request *hash,
445 struct nvmet_tcp_cmd *cmd)
447 ahash_request_set_crypt(hash, cmd->req.sg,
448 (void *)&cmd->exp_ddgst, cmd->req.transfer_len);
449 crypto_ahash_digest(hash);
452 static void nvmet_setup_c2h_data_pdu(struct nvmet_tcp_cmd *cmd)
454 struct nvme_tcp_data_pdu *pdu = cmd->data_pdu;
455 struct nvmet_tcp_queue *queue = cmd->queue;
456 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
457 u8 ddgst = nvmet_tcp_ddgst_len(cmd->queue);
460 cmd->state = NVMET_TCP_SEND_DATA_PDU;
462 pdu->hdr.type = nvme_tcp_c2h_data;
463 pdu->hdr.flags = NVME_TCP_F_DATA_LAST | (queue->nvme_sq.sqhd_disabled ?
464 NVME_TCP_F_DATA_SUCCESS : 0);
465 pdu->hdr.hlen = sizeof(*pdu);
466 pdu->hdr.pdo = pdu->hdr.hlen + hdgst;
468 cpu_to_le32(pdu->hdr.hlen + hdgst +
469 cmd->req.transfer_len + ddgst);
470 pdu->command_id = cmd->req.cqe->command_id;
471 pdu->data_length = cpu_to_le32(cmd->req.transfer_len);
472 pdu->data_offset = cpu_to_le32(cmd->wbytes_done);
474 if (queue->data_digest) {
475 pdu->hdr.flags |= NVME_TCP_F_DDGST;
476 nvmet_tcp_calc_ddgst(queue->snd_hash, cmd);
479 if (cmd->queue->hdr_digest) {
480 pdu->hdr.flags |= NVME_TCP_F_HDGST;
481 nvmet_tcp_hdgst(queue->snd_hash, pdu, sizeof(*pdu));
485 static void nvmet_setup_r2t_pdu(struct nvmet_tcp_cmd *cmd)
487 struct nvme_tcp_r2t_pdu *pdu = cmd->r2t_pdu;
488 struct nvmet_tcp_queue *queue = cmd->queue;
489 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
492 cmd->state = NVMET_TCP_SEND_R2T;
494 pdu->hdr.type = nvme_tcp_r2t;
496 pdu->hdr.hlen = sizeof(*pdu);
498 pdu->hdr.plen = cpu_to_le32(pdu->hdr.hlen + hdgst);
500 pdu->command_id = cmd->req.cmd->common.command_id;
501 pdu->ttag = nvmet_tcp_cmd_tag(cmd->queue, cmd);
502 pdu->r2t_length = cpu_to_le32(cmd->req.transfer_len - cmd->rbytes_done);
503 pdu->r2t_offset = cpu_to_le32(cmd->rbytes_done);
504 if (cmd->queue->hdr_digest) {
505 pdu->hdr.flags |= NVME_TCP_F_HDGST;
506 nvmet_tcp_hdgst(queue->snd_hash, pdu, sizeof(*pdu));
510 static void nvmet_setup_response_pdu(struct nvmet_tcp_cmd *cmd)
512 struct nvme_tcp_rsp_pdu *pdu = cmd->rsp_pdu;
513 struct nvmet_tcp_queue *queue = cmd->queue;
514 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
517 cmd->state = NVMET_TCP_SEND_RESPONSE;
519 pdu->hdr.type = nvme_tcp_rsp;
521 pdu->hdr.hlen = sizeof(*pdu);
523 pdu->hdr.plen = cpu_to_le32(pdu->hdr.hlen + hdgst);
524 if (cmd->queue->hdr_digest) {
525 pdu->hdr.flags |= NVME_TCP_F_HDGST;
526 nvmet_tcp_hdgst(queue->snd_hash, pdu, sizeof(*pdu));
530 static void nvmet_tcp_process_resp_list(struct nvmet_tcp_queue *queue)
532 struct llist_node *node;
533 struct nvmet_tcp_cmd *cmd;
535 for (node = llist_del_all(&queue->resp_list); node; node = node->next) {
536 cmd = llist_entry(node, struct nvmet_tcp_cmd, lentry);
537 list_add(&cmd->entry, &queue->resp_send_list);
538 queue->send_list_len++;
542 static struct nvmet_tcp_cmd *nvmet_tcp_fetch_cmd(struct nvmet_tcp_queue *queue)
544 queue->snd_cmd = list_first_entry_or_null(&queue->resp_send_list,
545 struct nvmet_tcp_cmd, entry);
546 if (!queue->snd_cmd) {
547 nvmet_tcp_process_resp_list(queue);
549 list_first_entry_or_null(&queue->resp_send_list,
550 struct nvmet_tcp_cmd, entry);
551 if (unlikely(!queue->snd_cmd))
555 list_del_init(&queue->snd_cmd->entry);
556 queue->send_list_len--;
558 if (nvmet_tcp_need_data_out(queue->snd_cmd))
559 nvmet_setup_c2h_data_pdu(queue->snd_cmd);
560 else if (nvmet_tcp_need_data_in(queue->snd_cmd))
561 nvmet_setup_r2t_pdu(queue->snd_cmd);
563 nvmet_setup_response_pdu(queue->snd_cmd);
565 return queue->snd_cmd;
568 static void nvmet_tcp_queue_response(struct nvmet_req *req)
570 struct nvmet_tcp_cmd *cmd =
571 container_of(req, struct nvmet_tcp_cmd, req);
572 struct nvmet_tcp_queue *queue = cmd->queue;
573 struct nvme_sgl_desc *sgl;
576 if (unlikely(cmd == queue->cmd)) {
577 sgl = &cmd->req.cmd->common.dptr.sgl;
578 len = le32_to_cpu(sgl->length);
581 * Wait for inline data before processing the response.
582 * Avoid using helpers, this might happen before
583 * nvmet_req_init is completed.
585 if (queue->rcv_state == NVMET_TCP_RECV_PDU &&
586 len && len <= cmd->req.port->inline_data_size &&
587 nvme_is_write(cmd->req.cmd))
591 llist_add(&cmd->lentry, &queue->resp_list);
592 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &cmd->queue->io_work);
595 static void nvmet_tcp_execute_request(struct nvmet_tcp_cmd *cmd)
597 if (unlikely(cmd->flags & NVMET_TCP_F_INIT_FAILED))
598 nvmet_tcp_queue_response(&cmd->req);
600 cmd->req.execute(&cmd->req);
603 static int nvmet_try_send_data_pdu(struct nvmet_tcp_cmd *cmd)
605 struct msghdr msg = {
606 .msg_flags = MSG_DONTWAIT | MSG_MORE | MSG_SPLICE_PAGES,
609 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
610 int left = sizeof(*cmd->data_pdu) - cmd->offset + hdgst;
613 bvec_set_virt(&bvec, (void *)cmd->data_pdu + cmd->offset, left);
614 iov_iter_bvec(&msg.msg_iter, ITER_SOURCE, &bvec, 1, left);
615 ret = sock_sendmsg(cmd->queue->sock, &msg);
625 cmd->state = NVMET_TCP_SEND_DATA;
630 static int nvmet_try_send_data(struct nvmet_tcp_cmd *cmd, bool last_in_batch)
632 struct nvmet_tcp_queue *queue = cmd->queue;
635 while (cmd->cur_sg) {
636 struct msghdr msg = {
637 .msg_flags = MSG_DONTWAIT | MSG_SPLICE_PAGES,
639 struct page *page = sg_page(cmd->cur_sg);
641 u32 left = cmd->cur_sg->length - cmd->offset;
643 if ((!last_in_batch && cmd->queue->send_list_len) ||
644 cmd->wbytes_done + left < cmd->req.transfer_len ||
645 queue->data_digest || !queue->nvme_sq.sqhd_disabled)
646 msg.msg_flags |= MSG_MORE;
648 bvec_set_page(&bvec, page, left, cmd->offset);
649 iov_iter_bvec(&msg.msg_iter, ITER_SOURCE, &bvec, 1, left);
650 ret = sock_sendmsg(cmd->queue->sock, &msg);
655 cmd->wbytes_done += ret;
658 if (cmd->offset == cmd->cur_sg->length) {
659 cmd->cur_sg = sg_next(cmd->cur_sg);
664 if (queue->data_digest) {
665 cmd->state = NVMET_TCP_SEND_DDGST;
668 if (queue->nvme_sq.sqhd_disabled) {
669 cmd->queue->snd_cmd = NULL;
670 nvmet_tcp_put_cmd(cmd);
672 nvmet_setup_response_pdu(cmd);
676 if (queue->nvme_sq.sqhd_disabled)
677 nvmet_tcp_free_cmd_buffers(cmd);
683 static int nvmet_try_send_response(struct nvmet_tcp_cmd *cmd,
686 struct msghdr msg = { .msg_flags = MSG_DONTWAIT | MSG_SPLICE_PAGES, };
688 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
689 int left = sizeof(*cmd->rsp_pdu) - cmd->offset + hdgst;
692 if (!last_in_batch && cmd->queue->send_list_len)
693 msg.msg_flags |= MSG_MORE;
695 msg.msg_flags |= MSG_EOR;
697 bvec_set_virt(&bvec, (void *)cmd->rsp_pdu + cmd->offset, left);
698 iov_iter_bvec(&msg.msg_iter, ITER_SOURCE, &bvec, 1, left);
699 ret = sock_sendmsg(cmd->queue->sock, &msg);
708 nvmet_tcp_free_cmd_buffers(cmd);
709 cmd->queue->snd_cmd = NULL;
710 nvmet_tcp_put_cmd(cmd);
714 static int nvmet_try_send_r2t(struct nvmet_tcp_cmd *cmd, bool last_in_batch)
716 struct msghdr msg = { .msg_flags = MSG_DONTWAIT | MSG_SPLICE_PAGES, };
718 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
719 int left = sizeof(*cmd->r2t_pdu) - cmd->offset + hdgst;
722 if (!last_in_batch && cmd->queue->send_list_len)
723 msg.msg_flags |= MSG_MORE;
725 msg.msg_flags |= MSG_EOR;
727 bvec_set_virt(&bvec, (void *)cmd->r2t_pdu + cmd->offset, left);
728 iov_iter_bvec(&msg.msg_iter, ITER_SOURCE, &bvec, 1, left);
729 ret = sock_sendmsg(cmd->queue->sock, &msg);
738 cmd->queue->snd_cmd = NULL;
742 static int nvmet_try_send_ddgst(struct nvmet_tcp_cmd *cmd, bool last_in_batch)
744 struct nvmet_tcp_queue *queue = cmd->queue;
745 int left = NVME_TCP_DIGEST_LENGTH - cmd->offset;
746 struct msghdr msg = { .msg_flags = MSG_DONTWAIT };
748 .iov_base = (u8 *)&cmd->exp_ddgst + cmd->offset,
753 if (!last_in_batch && cmd->queue->send_list_len)
754 msg.msg_flags |= MSG_MORE;
756 msg.msg_flags |= MSG_EOR;
758 ret = kernel_sendmsg(queue->sock, &msg, &iov, 1, iov.iov_len);
759 if (unlikely(ret <= 0))
768 if (queue->nvme_sq.sqhd_disabled) {
769 cmd->queue->snd_cmd = NULL;
770 nvmet_tcp_put_cmd(cmd);
772 nvmet_setup_response_pdu(cmd);
777 static int nvmet_tcp_try_send_one(struct nvmet_tcp_queue *queue,
780 struct nvmet_tcp_cmd *cmd = queue->snd_cmd;
783 if (!cmd || queue->state == NVMET_TCP_Q_DISCONNECTING) {
784 cmd = nvmet_tcp_fetch_cmd(queue);
789 if (cmd->state == NVMET_TCP_SEND_DATA_PDU) {
790 ret = nvmet_try_send_data_pdu(cmd);
795 if (cmd->state == NVMET_TCP_SEND_DATA) {
796 ret = nvmet_try_send_data(cmd, last_in_batch);
801 if (cmd->state == NVMET_TCP_SEND_DDGST) {
802 ret = nvmet_try_send_ddgst(cmd, last_in_batch);
807 if (cmd->state == NVMET_TCP_SEND_R2T) {
808 ret = nvmet_try_send_r2t(cmd, last_in_batch);
813 if (cmd->state == NVMET_TCP_SEND_RESPONSE)
814 ret = nvmet_try_send_response(cmd, last_in_batch);
826 static int nvmet_tcp_try_send(struct nvmet_tcp_queue *queue,
827 int budget, int *sends)
831 for (i = 0; i < budget; i++) {
832 ret = nvmet_tcp_try_send_one(queue, i == budget - 1);
833 if (unlikely(ret < 0)) {
834 nvmet_tcp_socket_error(queue, ret);
836 } else if (ret == 0) {
845 static void nvmet_prepare_receive_pdu(struct nvmet_tcp_queue *queue)
848 queue->left = sizeof(struct nvme_tcp_hdr);
850 queue->rcv_state = NVMET_TCP_RECV_PDU;
853 static void nvmet_tcp_free_crypto(struct nvmet_tcp_queue *queue)
855 struct crypto_ahash *tfm = crypto_ahash_reqtfm(queue->rcv_hash);
857 ahash_request_free(queue->rcv_hash);
858 ahash_request_free(queue->snd_hash);
859 crypto_free_ahash(tfm);
862 static int nvmet_tcp_alloc_crypto(struct nvmet_tcp_queue *queue)
864 struct crypto_ahash *tfm;
866 tfm = crypto_alloc_ahash("crc32c", 0, CRYPTO_ALG_ASYNC);
870 queue->snd_hash = ahash_request_alloc(tfm, GFP_KERNEL);
871 if (!queue->snd_hash)
873 ahash_request_set_callback(queue->snd_hash, 0, NULL, NULL);
875 queue->rcv_hash = ahash_request_alloc(tfm, GFP_KERNEL);
876 if (!queue->rcv_hash)
878 ahash_request_set_callback(queue->rcv_hash, 0, NULL, NULL);
882 ahash_request_free(queue->snd_hash);
884 crypto_free_ahash(tfm);
889 static int nvmet_tcp_handle_icreq(struct nvmet_tcp_queue *queue)
891 struct nvme_tcp_icreq_pdu *icreq = &queue->pdu.icreq;
892 struct nvme_tcp_icresp_pdu *icresp = &queue->pdu.icresp;
893 struct msghdr msg = {};
897 if (le32_to_cpu(icreq->hdr.plen) != sizeof(struct nvme_tcp_icreq_pdu)) {
898 pr_err("bad nvme-tcp pdu length (%d)\n",
899 le32_to_cpu(icreq->hdr.plen));
900 nvmet_tcp_fatal_error(queue);
904 if (icreq->pfv != NVME_TCP_PFV_1_0) {
905 pr_err("queue %d: bad pfv %d\n", queue->idx, icreq->pfv);
909 if (icreq->hpda != 0) {
910 pr_err("queue %d: unsupported hpda %d\n", queue->idx,
915 queue->hdr_digest = !!(icreq->digest & NVME_TCP_HDR_DIGEST_ENABLE);
916 queue->data_digest = !!(icreq->digest & NVME_TCP_DATA_DIGEST_ENABLE);
917 if (queue->hdr_digest || queue->data_digest) {
918 ret = nvmet_tcp_alloc_crypto(queue);
923 memset(icresp, 0, sizeof(*icresp));
924 icresp->hdr.type = nvme_tcp_icresp;
925 icresp->hdr.hlen = sizeof(*icresp);
927 icresp->hdr.plen = cpu_to_le32(icresp->hdr.hlen);
928 icresp->pfv = cpu_to_le16(NVME_TCP_PFV_1_0);
929 icresp->maxdata = cpu_to_le32(NVMET_TCP_MAXH2CDATA);
931 if (queue->hdr_digest)
932 icresp->digest |= NVME_TCP_HDR_DIGEST_ENABLE;
933 if (queue->data_digest)
934 icresp->digest |= NVME_TCP_DATA_DIGEST_ENABLE;
936 iov.iov_base = icresp;
937 iov.iov_len = sizeof(*icresp);
938 ret = kernel_sendmsg(queue->sock, &msg, &iov, 1, iov.iov_len);
940 queue->state = NVMET_TCP_Q_FAILED;
941 return ret; /* queue removal will cleanup */
944 queue->state = NVMET_TCP_Q_LIVE;
945 nvmet_prepare_receive_pdu(queue);
949 static void nvmet_tcp_handle_req_failure(struct nvmet_tcp_queue *queue,
950 struct nvmet_tcp_cmd *cmd, struct nvmet_req *req)
952 size_t data_len = le32_to_cpu(req->cmd->common.dptr.sgl.length);
956 * This command has not been processed yet, hence we are trying to
957 * figure out if there is still pending data left to receive. If
958 * we don't, we can simply prepare for the next pdu and bail out,
959 * otherwise we will need to prepare a buffer and receive the
960 * stale data before continuing forward.
962 if (!nvme_is_write(cmd->req.cmd) || !data_len ||
963 data_len > cmd->req.port->inline_data_size) {
964 nvmet_prepare_receive_pdu(queue);
968 ret = nvmet_tcp_map_data(cmd);
970 pr_err("queue %d: failed to map data\n", queue->idx);
971 nvmet_tcp_fatal_error(queue);
975 queue->rcv_state = NVMET_TCP_RECV_DATA;
976 nvmet_tcp_build_pdu_iovec(cmd);
977 cmd->flags |= NVMET_TCP_F_INIT_FAILED;
980 static int nvmet_tcp_handle_h2c_data_pdu(struct nvmet_tcp_queue *queue)
982 struct nvme_tcp_data_pdu *data = &queue->pdu.data;
983 struct nvmet_tcp_cmd *cmd;
984 unsigned int exp_data_len;
986 if (likely(queue->nr_cmds)) {
987 if (unlikely(data->ttag >= queue->nr_cmds)) {
988 pr_err("queue %d: received out of bound ttag %u, nr_cmds %u\n",
989 queue->idx, data->ttag, queue->nr_cmds);
992 cmd = &queue->cmds[data->ttag];
994 cmd = &queue->connect;
997 if (le32_to_cpu(data->data_offset) != cmd->rbytes_done) {
998 pr_err("ttag %u unexpected data offset %u (expected %u)\n",
999 data->ttag, le32_to_cpu(data->data_offset),
1004 exp_data_len = le32_to_cpu(data->hdr.plen) -
1005 nvmet_tcp_hdgst_len(queue) -
1006 nvmet_tcp_ddgst_len(queue) -
1009 cmd->pdu_len = le32_to_cpu(data->data_length);
1010 if (unlikely(cmd->pdu_len != exp_data_len ||
1011 cmd->pdu_len == 0 ||
1012 cmd->pdu_len > NVMET_TCP_MAXH2CDATA)) {
1013 pr_err("H2CData PDU len %u is invalid\n", cmd->pdu_len);
1017 nvmet_tcp_build_pdu_iovec(cmd);
1019 queue->rcv_state = NVMET_TCP_RECV_DATA;
1024 /* FIXME: use proper transport errors */
1025 nvmet_tcp_fatal_error(queue);
1029 static int nvmet_tcp_done_recv_pdu(struct nvmet_tcp_queue *queue)
1031 struct nvme_tcp_hdr *hdr = &queue->pdu.cmd.hdr;
1032 struct nvme_command *nvme_cmd = &queue->pdu.cmd.cmd;
1033 struct nvmet_req *req;
1036 if (unlikely(queue->state == NVMET_TCP_Q_CONNECTING)) {
1037 if (hdr->type != nvme_tcp_icreq) {
1038 pr_err("unexpected pdu type (%d) before icreq\n",
1040 nvmet_tcp_fatal_error(queue);
1043 return nvmet_tcp_handle_icreq(queue);
1046 if (unlikely(hdr->type == nvme_tcp_icreq)) {
1047 pr_err("queue %d: received icreq pdu in state %d\n",
1048 queue->idx, queue->state);
1049 nvmet_tcp_fatal_error(queue);
1053 if (hdr->type == nvme_tcp_h2c_data) {
1054 ret = nvmet_tcp_handle_h2c_data_pdu(queue);
1060 queue->cmd = nvmet_tcp_get_cmd(queue);
1061 if (unlikely(!queue->cmd)) {
1062 /* This should never happen */
1063 pr_err("queue %d: out of commands (%d) send_list_len: %d, opcode: %d",
1064 queue->idx, queue->nr_cmds, queue->send_list_len,
1065 nvme_cmd->common.opcode);
1066 nvmet_tcp_fatal_error(queue);
1070 req = &queue->cmd->req;
1071 memcpy(req->cmd, nvme_cmd, sizeof(*nvme_cmd));
1073 if (unlikely(!nvmet_req_init(req, &queue->nvme_cq,
1074 &queue->nvme_sq, &nvmet_tcp_ops))) {
1075 pr_err("failed cmd %p id %d opcode %d, data_len: %d\n",
1076 req->cmd, req->cmd->common.command_id,
1077 req->cmd->common.opcode,
1078 le32_to_cpu(req->cmd->common.dptr.sgl.length));
1080 nvmet_tcp_handle_req_failure(queue, queue->cmd, req);
1084 ret = nvmet_tcp_map_data(queue->cmd);
1085 if (unlikely(ret)) {
1086 pr_err("queue %d: failed to map data\n", queue->idx);
1087 if (nvmet_tcp_has_inline_data(queue->cmd))
1088 nvmet_tcp_fatal_error(queue);
1090 nvmet_req_complete(req, ret);
1095 if (nvmet_tcp_need_data_in(queue->cmd)) {
1096 if (nvmet_tcp_has_inline_data(queue->cmd)) {
1097 queue->rcv_state = NVMET_TCP_RECV_DATA;
1098 nvmet_tcp_build_pdu_iovec(queue->cmd);
1102 nvmet_tcp_queue_response(&queue->cmd->req);
1106 queue->cmd->req.execute(&queue->cmd->req);
1108 nvmet_prepare_receive_pdu(queue);
1112 static const u8 nvme_tcp_pdu_sizes[] = {
1113 [nvme_tcp_icreq] = sizeof(struct nvme_tcp_icreq_pdu),
1114 [nvme_tcp_cmd] = sizeof(struct nvme_tcp_cmd_pdu),
1115 [nvme_tcp_h2c_data] = sizeof(struct nvme_tcp_data_pdu),
1118 static inline u8 nvmet_tcp_pdu_size(u8 type)
1122 return (idx < ARRAY_SIZE(nvme_tcp_pdu_sizes) &&
1123 nvme_tcp_pdu_sizes[idx]) ?
1124 nvme_tcp_pdu_sizes[idx] : 0;
1127 static inline bool nvmet_tcp_pdu_valid(u8 type)
1130 case nvme_tcp_icreq:
1132 case nvme_tcp_h2c_data:
1140 static int nvmet_tcp_tls_record_ok(struct nvmet_tcp_queue *queue,
1141 struct msghdr *msg, char *cbuf)
1143 struct cmsghdr *cmsg = (struct cmsghdr *)cbuf;
1144 u8 ctype, level, description;
1147 ctype = tls_get_record_type(queue->sock->sk, cmsg);
1151 case TLS_RECORD_TYPE_DATA:
1153 case TLS_RECORD_TYPE_ALERT:
1154 tls_alert_recv(queue->sock->sk, msg, &level, &description);
1155 if (level == TLS_ALERT_LEVEL_FATAL) {
1156 pr_err("queue %d: TLS Alert desc %u\n",
1157 queue->idx, description);
1160 pr_warn("queue %d: TLS Alert desc %u\n",
1161 queue->idx, description);
1166 /* discard this record type */
1167 pr_err("queue %d: TLS record %d unhandled\n",
1175 static int nvmet_tcp_try_recv_pdu(struct nvmet_tcp_queue *queue)
1177 struct nvme_tcp_hdr *hdr = &queue->pdu.cmd.hdr;
1180 char cbuf[CMSG_LEN(sizeof(char))] = {};
1181 struct msghdr msg = { .msg_flags = MSG_DONTWAIT };
1184 iov.iov_base = (void *)&queue->pdu + queue->offset;
1185 iov.iov_len = queue->left;
1186 if (queue->tls_pskid) {
1187 msg.msg_control = cbuf;
1188 msg.msg_controllen = sizeof(cbuf);
1190 len = kernel_recvmsg(queue->sock, &msg, &iov, 1,
1191 iov.iov_len, msg.msg_flags);
1192 if (unlikely(len < 0))
1194 if (queue->tls_pskid) {
1195 ret = nvmet_tcp_tls_record_ok(queue, &msg, cbuf);
1200 queue->offset += len;
1205 if (queue->offset == sizeof(struct nvme_tcp_hdr)) {
1206 u8 hdgst = nvmet_tcp_hdgst_len(queue);
1208 if (unlikely(!nvmet_tcp_pdu_valid(hdr->type))) {
1209 pr_err("unexpected pdu type %d\n", hdr->type);
1210 nvmet_tcp_fatal_error(queue);
1214 if (unlikely(hdr->hlen != nvmet_tcp_pdu_size(hdr->type))) {
1215 pr_err("pdu %d bad hlen %d\n", hdr->type, hdr->hlen);
1219 queue->left = hdr->hlen - queue->offset + hdgst;
1223 if (queue->hdr_digest &&
1224 nvmet_tcp_verify_hdgst(queue, &queue->pdu, hdr->hlen)) {
1225 nvmet_tcp_fatal_error(queue); /* fatal */
1229 if (queue->data_digest &&
1230 nvmet_tcp_check_ddgst(queue, &queue->pdu)) {
1231 nvmet_tcp_fatal_error(queue); /* fatal */
1235 return nvmet_tcp_done_recv_pdu(queue);
1238 static void nvmet_tcp_prep_recv_ddgst(struct nvmet_tcp_cmd *cmd)
1240 struct nvmet_tcp_queue *queue = cmd->queue;
1242 nvmet_tcp_calc_ddgst(queue->rcv_hash, cmd);
1244 queue->left = NVME_TCP_DIGEST_LENGTH;
1245 queue->rcv_state = NVMET_TCP_RECV_DDGST;
1248 static int nvmet_tcp_try_recv_data(struct nvmet_tcp_queue *queue)
1250 struct nvmet_tcp_cmd *cmd = queue->cmd;
1253 while (msg_data_left(&cmd->recv_msg)) {
1254 len = sock_recvmsg(cmd->queue->sock, &cmd->recv_msg,
1255 cmd->recv_msg.msg_flags);
1258 if (queue->tls_pskid) {
1259 ret = nvmet_tcp_tls_record_ok(cmd->queue,
1260 &cmd->recv_msg, cmd->recv_cbuf);
1265 cmd->pdu_recv += len;
1266 cmd->rbytes_done += len;
1269 if (queue->data_digest) {
1270 nvmet_tcp_prep_recv_ddgst(cmd);
1274 if (cmd->rbytes_done == cmd->req.transfer_len)
1275 nvmet_tcp_execute_request(cmd);
1277 nvmet_prepare_receive_pdu(queue);
1281 static int nvmet_tcp_try_recv_ddgst(struct nvmet_tcp_queue *queue)
1283 struct nvmet_tcp_cmd *cmd = queue->cmd;
1285 char cbuf[CMSG_LEN(sizeof(char))] = {};
1286 struct msghdr msg = { .msg_flags = MSG_DONTWAIT };
1288 .iov_base = (void *)&cmd->recv_ddgst + queue->offset,
1289 .iov_len = queue->left
1292 if (queue->tls_pskid) {
1293 msg.msg_control = cbuf;
1294 msg.msg_controllen = sizeof(cbuf);
1296 len = kernel_recvmsg(queue->sock, &msg, &iov, 1,
1297 iov.iov_len, msg.msg_flags);
1298 if (unlikely(len < 0))
1300 if (queue->tls_pskid) {
1301 ret = nvmet_tcp_tls_record_ok(queue, &msg, cbuf);
1306 queue->offset += len;
1311 if (queue->data_digest && cmd->exp_ddgst != cmd->recv_ddgst) {
1312 pr_err("queue %d: cmd %d pdu (%d) data digest error: recv %#x expected %#x\n",
1313 queue->idx, cmd->req.cmd->common.command_id,
1314 queue->pdu.cmd.hdr.type, le32_to_cpu(cmd->recv_ddgst),
1315 le32_to_cpu(cmd->exp_ddgst));
1316 nvmet_req_uninit(&cmd->req);
1317 nvmet_tcp_free_cmd_buffers(cmd);
1318 nvmet_tcp_fatal_error(queue);
1323 if (cmd->rbytes_done == cmd->req.transfer_len)
1324 nvmet_tcp_execute_request(cmd);
1328 nvmet_prepare_receive_pdu(queue);
1332 static int nvmet_tcp_try_recv_one(struct nvmet_tcp_queue *queue)
1336 if (unlikely(queue->rcv_state == NVMET_TCP_RECV_ERR))
1339 if (queue->rcv_state == NVMET_TCP_RECV_PDU) {
1340 result = nvmet_tcp_try_recv_pdu(queue);
1345 if (queue->rcv_state == NVMET_TCP_RECV_DATA) {
1346 result = nvmet_tcp_try_recv_data(queue);
1351 if (queue->rcv_state == NVMET_TCP_RECV_DDGST) {
1352 result = nvmet_tcp_try_recv_ddgst(queue);
1359 if (result == -EAGAIN)
1366 static int nvmet_tcp_try_recv(struct nvmet_tcp_queue *queue,
1367 int budget, int *recvs)
1371 for (i = 0; i < budget; i++) {
1372 ret = nvmet_tcp_try_recv_one(queue);
1373 if (unlikely(ret < 0)) {
1374 nvmet_tcp_socket_error(queue, ret);
1376 } else if (ret == 0) {
1385 static void nvmet_tcp_release_queue(struct kref *kref)
1387 struct nvmet_tcp_queue *queue =
1388 container_of(kref, struct nvmet_tcp_queue, kref);
1390 WARN_ON(queue->state != NVMET_TCP_Q_DISCONNECTING);
1391 queue_work(nvmet_wq, &queue->release_work);
1394 static void nvmet_tcp_schedule_release_queue(struct nvmet_tcp_queue *queue)
1396 spin_lock_bh(&queue->state_lock);
1397 if (queue->state == NVMET_TCP_Q_TLS_HANDSHAKE) {
1398 /* Socket closed during handshake */
1399 tls_handshake_cancel(queue->sock->sk);
1401 if (queue->state != NVMET_TCP_Q_DISCONNECTING) {
1402 queue->state = NVMET_TCP_Q_DISCONNECTING;
1403 kref_put(&queue->kref, nvmet_tcp_release_queue);
1405 spin_unlock_bh(&queue->state_lock);
1408 static inline void nvmet_tcp_arm_queue_deadline(struct nvmet_tcp_queue *queue)
1410 queue->poll_end = jiffies + usecs_to_jiffies(idle_poll_period_usecs);
1413 static bool nvmet_tcp_check_queue_deadline(struct nvmet_tcp_queue *queue,
1416 if (!idle_poll_period_usecs)
1420 nvmet_tcp_arm_queue_deadline(queue);
1422 return !time_after(jiffies, queue->poll_end);
1425 static void nvmet_tcp_io_work(struct work_struct *w)
1427 struct nvmet_tcp_queue *queue =
1428 container_of(w, struct nvmet_tcp_queue, io_work);
1435 ret = nvmet_tcp_try_recv(queue, NVMET_TCP_RECV_BUDGET, &ops);
1441 ret = nvmet_tcp_try_send(queue, NVMET_TCP_SEND_BUDGET, &ops);
1447 } while (pending && ops < NVMET_TCP_IO_WORK_BUDGET);
1450 * Requeue the worker if idle deadline period is in progress or any
1451 * ops activity was recorded during the do-while loop above.
1453 if (nvmet_tcp_check_queue_deadline(queue, ops) || pending)
1454 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &queue->io_work);
1457 static int nvmet_tcp_alloc_cmd(struct nvmet_tcp_queue *queue,
1458 struct nvmet_tcp_cmd *c)
1460 u8 hdgst = nvmet_tcp_hdgst_len(queue);
1463 c->req.port = queue->port->nport;
1465 c->cmd_pdu = page_frag_alloc(&queue->pf_cache,
1466 sizeof(*c->cmd_pdu) + hdgst, GFP_KERNEL | __GFP_ZERO);
1469 c->req.cmd = &c->cmd_pdu->cmd;
1471 c->rsp_pdu = page_frag_alloc(&queue->pf_cache,
1472 sizeof(*c->rsp_pdu) + hdgst, GFP_KERNEL | __GFP_ZERO);
1475 c->req.cqe = &c->rsp_pdu->cqe;
1477 c->data_pdu = page_frag_alloc(&queue->pf_cache,
1478 sizeof(*c->data_pdu) + hdgst, GFP_KERNEL | __GFP_ZERO);
1482 c->r2t_pdu = page_frag_alloc(&queue->pf_cache,
1483 sizeof(*c->r2t_pdu) + hdgst, GFP_KERNEL | __GFP_ZERO);
1487 if (queue->state == NVMET_TCP_Q_TLS_HANDSHAKE) {
1488 c->recv_msg.msg_control = c->recv_cbuf;
1489 c->recv_msg.msg_controllen = sizeof(c->recv_cbuf);
1491 c->recv_msg.msg_flags = MSG_DONTWAIT | MSG_NOSIGNAL;
1493 list_add_tail(&c->entry, &queue->free_list);
1497 page_frag_free(c->data_pdu);
1499 page_frag_free(c->rsp_pdu);
1501 page_frag_free(c->cmd_pdu);
1505 static void nvmet_tcp_free_cmd(struct nvmet_tcp_cmd *c)
1507 page_frag_free(c->r2t_pdu);
1508 page_frag_free(c->data_pdu);
1509 page_frag_free(c->rsp_pdu);
1510 page_frag_free(c->cmd_pdu);
1513 static int nvmet_tcp_alloc_cmds(struct nvmet_tcp_queue *queue)
1515 struct nvmet_tcp_cmd *cmds;
1516 int i, ret = -EINVAL, nr_cmds = queue->nr_cmds;
1518 cmds = kcalloc(nr_cmds, sizeof(struct nvmet_tcp_cmd), GFP_KERNEL);
1522 for (i = 0; i < nr_cmds; i++) {
1523 ret = nvmet_tcp_alloc_cmd(queue, cmds + i);
1533 nvmet_tcp_free_cmd(cmds + i);
1539 static void nvmet_tcp_free_cmds(struct nvmet_tcp_queue *queue)
1541 struct nvmet_tcp_cmd *cmds = queue->cmds;
1544 for (i = 0; i < queue->nr_cmds; i++)
1545 nvmet_tcp_free_cmd(cmds + i);
1547 nvmet_tcp_free_cmd(&queue->connect);
1551 static void nvmet_tcp_restore_socket_callbacks(struct nvmet_tcp_queue *queue)
1553 struct socket *sock = queue->sock;
1555 write_lock_bh(&sock->sk->sk_callback_lock);
1556 sock->sk->sk_data_ready = queue->data_ready;
1557 sock->sk->sk_state_change = queue->state_change;
1558 sock->sk->sk_write_space = queue->write_space;
1559 sock->sk->sk_user_data = NULL;
1560 write_unlock_bh(&sock->sk->sk_callback_lock);
1563 static void nvmet_tcp_uninit_data_in_cmds(struct nvmet_tcp_queue *queue)
1565 struct nvmet_tcp_cmd *cmd = queue->cmds;
1568 for (i = 0; i < queue->nr_cmds; i++, cmd++) {
1569 if (nvmet_tcp_need_data_in(cmd))
1570 nvmet_req_uninit(&cmd->req);
1573 if (!queue->nr_cmds && nvmet_tcp_need_data_in(&queue->connect)) {
1574 /* failed in connect */
1575 nvmet_req_uninit(&queue->connect.req);
1579 static void nvmet_tcp_free_cmd_data_in_buffers(struct nvmet_tcp_queue *queue)
1581 struct nvmet_tcp_cmd *cmd = queue->cmds;
1584 for (i = 0; i < queue->nr_cmds; i++, cmd++) {
1585 if (nvmet_tcp_need_data_in(cmd))
1586 nvmet_tcp_free_cmd_buffers(cmd);
1589 if (!queue->nr_cmds && nvmet_tcp_need_data_in(&queue->connect))
1590 nvmet_tcp_free_cmd_buffers(&queue->connect);
1593 static void nvmet_tcp_release_queue_work(struct work_struct *w)
1595 struct nvmet_tcp_queue *queue =
1596 container_of(w, struct nvmet_tcp_queue, release_work);
1598 mutex_lock(&nvmet_tcp_queue_mutex);
1599 list_del_init(&queue->queue_list);
1600 mutex_unlock(&nvmet_tcp_queue_mutex);
1602 nvmet_tcp_restore_socket_callbacks(queue);
1603 cancel_delayed_work_sync(&queue->tls_handshake_tmo_work);
1604 cancel_work_sync(&queue->io_work);
1605 /* stop accepting incoming data */
1606 queue->rcv_state = NVMET_TCP_RECV_ERR;
1608 nvmet_tcp_uninit_data_in_cmds(queue);
1609 nvmet_sq_destroy(&queue->nvme_sq);
1610 cancel_work_sync(&queue->io_work);
1611 nvmet_tcp_free_cmd_data_in_buffers(queue);
1612 /* ->sock will be released by fput() */
1613 fput(queue->sock->file);
1614 nvmet_tcp_free_cmds(queue);
1615 if (queue->hdr_digest || queue->data_digest)
1616 nvmet_tcp_free_crypto(queue);
1617 ida_free(&nvmet_tcp_queue_ida, queue->idx);
1618 page_frag_cache_drain(&queue->pf_cache);
1622 static void nvmet_tcp_data_ready(struct sock *sk)
1624 struct nvmet_tcp_queue *queue;
1626 trace_sk_data_ready(sk);
1628 read_lock_bh(&sk->sk_callback_lock);
1629 queue = sk->sk_user_data;
1630 if (likely(queue)) {
1631 if (queue->data_ready)
1632 queue->data_ready(sk);
1633 if (queue->state != NVMET_TCP_Q_TLS_HANDSHAKE)
1634 queue_work_on(queue_cpu(queue), nvmet_tcp_wq,
1637 read_unlock_bh(&sk->sk_callback_lock);
1640 static void nvmet_tcp_write_space(struct sock *sk)
1642 struct nvmet_tcp_queue *queue;
1644 read_lock_bh(&sk->sk_callback_lock);
1645 queue = sk->sk_user_data;
1646 if (unlikely(!queue))
1649 if (unlikely(queue->state == NVMET_TCP_Q_CONNECTING)) {
1650 queue->write_space(sk);
1654 if (sk_stream_is_writeable(sk)) {
1655 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1656 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &queue->io_work);
1659 read_unlock_bh(&sk->sk_callback_lock);
1662 static void nvmet_tcp_state_change(struct sock *sk)
1664 struct nvmet_tcp_queue *queue;
1666 read_lock_bh(&sk->sk_callback_lock);
1667 queue = sk->sk_user_data;
1671 switch (sk->sk_state) {
1676 case TCP_CLOSE_WAIT:
1679 nvmet_tcp_schedule_release_queue(queue);
1682 pr_warn("queue %d unhandled state %d\n",
1683 queue->idx, sk->sk_state);
1686 read_unlock_bh(&sk->sk_callback_lock);
1689 static int nvmet_tcp_set_queue_sock(struct nvmet_tcp_queue *queue)
1691 struct socket *sock = queue->sock;
1692 struct inet_sock *inet = inet_sk(sock->sk);
1695 ret = kernel_getsockname(sock,
1696 (struct sockaddr *)&queue->sockaddr);
1700 ret = kernel_getpeername(sock,
1701 (struct sockaddr *)&queue->sockaddr_peer);
1706 * Cleanup whatever is sitting in the TCP transmit queue on socket
1707 * close. This is done to prevent stale data from being sent should
1708 * the network connection be restored before TCP times out.
1710 sock_no_linger(sock->sk);
1712 if (so_priority > 0)
1713 sock_set_priority(sock->sk, so_priority);
1715 /* Set socket type of service */
1716 if (inet->rcv_tos > 0)
1717 ip_sock_set_tos(sock->sk, inet->rcv_tos);
1720 write_lock_bh(&sock->sk->sk_callback_lock);
1721 if (sock->sk->sk_state != TCP_ESTABLISHED) {
1723 * If the socket is already closing, don't even start
1728 sock->sk->sk_user_data = queue;
1729 queue->data_ready = sock->sk->sk_data_ready;
1730 sock->sk->sk_data_ready = nvmet_tcp_data_ready;
1731 queue->state_change = sock->sk->sk_state_change;
1732 sock->sk->sk_state_change = nvmet_tcp_state_change;
1733 queue->write_space = sock->sk->sk_write_space;
1734 sock->sk->sk_write_space = nvmet_tcp_write_space;
1735 if (idle_poll_period_usecs)
1736 nvmet_tcp_arm_queue_deadline(queue);
1737 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &queue->io_work);
1739 write_unlock_bh(&sock->sk->sk_callback_lock);
1744 #ifdef CONFIG_NVME_TARGET_TCP_TLS
1745 static int nvmet_tcp_try_peek_pdu(struct nvmet_tcp_queue *queue)
1747 struct nvme_tcp_hdr *hdr = &queue->pdu.cmd.hdr;
1750 .iov_base = (u8 *)&queue->pdu + queue->offset,
1751 .iov_len = sizeof(struct nvme_tcp_hdr),
1753 char cbuf[CMSG_LEN(sizeof(char))] = {};
1754 struct msghdr msg = {
1755 .msg_control = cbuf,
1756 .msg_controllen = sizeof(cbuf),
1757 .msg_flags = MSG_PEEK,
1760 if (nvmet_port_secure_channel_required(queue->port->nport))
1763 len = kernel_recvmsg(queue->sock, &msg, &iov, 1,
1764 iov.iov_len, msg.msg_flags);
1765 if (unlikely(len < 0)) {
1766 pr_debug("queue %d: peek error %d\n",
1771 ret = nvmet_tcp_tls_record_ok(queue, &msg, cbuf);
1775 if (len < sizeof(struct nvme_tcp_hdr)) {
1776 pr_debug("queue %d: short read, %d bytes missing\n",
1777 queue->idx, (int)iov.iov_len - len);
1780 pr_debug("queue %d: hdr type %d hlen %d plen %d size %d\n",
1781 queue->idx, hdr->type, hdr->hlen, hdr->plen,
1782 (int)sizeof(struct nvme_tcp_icreq_pdu));
1783 if (hdr->type == nvme_tcp_icreq &&
1784 hdr->hlen == sizeof(struct nvme_tcp_icreq_pdu) &&
1785 hdr->plen == cpu_to_le32(sizeof(struct nvme_tcp_icreq_pdu))) {
1786 pr_debug("queue %d: icreq detected\n",
1793 static void nvmet_tcp_tls_handshake_done(void *data, int status,
1794 key_serial_t peerid)
1796 struct nvmet_tcp_queue *queue = data;
1798 pr_debug("queue %d: TLS handshake done, key %x, status %d\n",
1799 queue->idx, peerid, status);
1800 spin_lock_bh(&queue->state_lock);
1801 if (WARN_ON(queue->state != NVMET_TCP_Q_TLS_HANDSHAKE)) {
1802 spin_unlock_bh(&queue->state_lock);
1806 queue->tls_pskid = peerid;
1807 queue->state = NVMET_TCP_Q_CONNECTING;
1809 queue->state = NVMET_TCP_Q_FAILED;
1810 spin_unlock_bh(&queue->state_lock);
1812 cancel_delayed_work_sync(&queue->tls_handshake_tmo_work);
1814 nvmet_tcp_schedule_release_queue(queue);
1816 nvmet_tcp_set_queue_sock(queue);
1817 kref_put(&queue->kref, nvmet_tcp_release_queue);
1820 static void nvmet_tcp_tls_handshake_timeout(struct work_struct *w)
1822 struct nvmet_tcp_queue *queue = container_of(to_delayed_work(w),
1823 struct nvmet_tcp_queue, tls_handshake_tmo_work);
1825 pr_warn("queue %d: TLS handshake timeout\n", queue->idx);
1827 * If tls_handshake_cancel() fails we've lost the race with
1828 * nvmet_tcp_tls_handshake_done() */
1829 if (!tls_handshake_cancel(queue->sock->sk))
1831 spin_lock_bh(&queue->state_lock);
1832 if (WARN_ON(queue->state != NVMET_TCP_Q_TLS_HANDSHAKE)) {
1833 spin_unlock_bh(&queue->state_lock);
1836 queue->state = NVMET_TCP_Q_FAILED;
1837 spin_unlock_bh(&queue->state_lock);
1838 nvmet_tcp_schedule_release_queue(queue);
1839 kref_put(&queue->kref, nvmet_tcp_release_queue);
1842 static int nvmet_tcp_tls_handshake(struct nvmet_tcp_queue *queue)
1844 int ret = -EOPNOTSUPP;
1845 struct tls_handshake_args args;
1847 if (queue->state != NVMET_TCP_Q_TLS_HANDSHAKE) {
1848 pr_warn("cannot start TLS in state %d\n", queue->state);
1852 kref_get(&queue->kref);
1853 pr_debug("queue %d: TLS ServerHello\n", queue->idx);
1854 memset(&args, 0, sizeof(args));
1855 args.ta_sock = queue->sock;
1856 args.ta_done = nvmet_tcp_tls_handshake_done;
1857 args.ta_data = queue;
1858 args.ta_keyring = key_serial(queue->port->nport->keyring);
1859 args.ta_timeout_ms = tls_handshake_timeout * 1000;
1861 ret = tls_server_hello_psk(&args, GFP_KERNEL);
1863 kref_put(&queue->kref, nvmet_tcp_release_queue);
1864 pr_err("failed to start TLS, err=%d\n", ret);
1866 queue_delayed_work(nvmet_wq, &queue->tls_handshake_tmo_work,
1867 tls_handshake_timeout * HZ);
1872 static void nvmet_tcp_tls_handshake_timeout(struct work_struct *w) {}
1875 static void nvmet_tcp_alloc_queue(struct nvmet_tcp_port *port,
1876 struct socket *newsock)
1878 struct nvmet_tcp_queue *queue;
1879 struct file *sock_file = NULL;
1882 queue = kzalloc(sizeof(*queue), GFP_KERNEL);
1888 INIT_WORK(&queue->release_work, nvmet_tcp_release_queue_work);
1889 INIT_WORK(&queue->io_work, nvmet_tcp_io_work);
1890 kref_init(&queue->kref);
1891 queue->sock = newsock;
1894 spin_lock_init(&queue->state_lock);
1895 if (queue->port->nport->disc_addr.tsas.tcp.sectype ==
1896 NVMF_TCP_SECTYPE_TLS13)
1897 queue->state = NVMET_TCP_Q_TLS_HANDSHAKE;
1899 queue->state = NVMET_TCP_Q_CONNECTING;
1900 INIT_LIST_HEAD(&queue->free_list);
1901 init_llist_head(&queue->resp_list);
1902 INIT_LIST_HEAD(&queue->resp_send_list);
1904 sock_file = sock_alloc_file(queue->sock, O_CLOEXEC, NULL);
1905 if (IS_ERR(sock_file)) {
1906 ret = PTR_ERR(sock_file);
1907 goto out_free_queue;
1910 queue->idx = ida_alloc(&nvmet_tcp_queue_ida, GFP_KERNEL);
1911 if (queue->idx < 0) {
1916 ret = nvmet_tcp_alloc_cmd(queue, &queue->connect);
1918 goto out_ida_remove;
1920 ret = nvmet_sq_init(&queue->nvme_sq);
1922 goto out_free_connect;
1924 nvmet_prepare_receive_pdu(queue);
1926 mutex_lock(&nvmet_tcp_queue_mutex);
1927 list_add_tail(&queue->queue_list, &nvmet_tcp_queue_list);
1928 mutex_unlock(&nvmet_tcp_queue_mutex);
1930 INIT_DELAYED_WORK(&queue->tls_handshake_tmo_work,
1931 nvmet_tcp_tls_handshake_timeout);
1932 #ifdef CONFIG_NVME_TARGET_TCP_TLS
1933 if (queue->state == NVMET_TCP_Q_TLS_HANDSHAKE) {
1934 struct sock *sk = queue->sock->sk;
1936 /* Restore the default callbacks before starting upcall */
1937 read_lock_bh(&sk->sk_callback_lock);
1938 sk->sk_user_data = NULL;
1939 sk->sk_data_ready = port->data_ready;
1940 read_unlock_bh(&sk->sk_callback_lock);
1941 if (!nvmet_tcp_try_peek_pdu(queue)) {
1942 if (!nvmet_tcp_tls_handshake(queue))
1944 /* TLS handshake failed, terminate the connection */
1945 goto out_destroy_sq;
1947 /* Not a TLS connection, continue with normal processing */
1948 queue->state = NVMET_TCP_Q_CONNECTING;
1952 ret = nvmet_tcp_set_queue_sock(queue);
1954 goto out_destroy_sq;
1958 mutex_lock(&nvmet_tcp_queue_mutex);
1959 list_del_init(&queue->queue_list);
1960 mutex_unlock(&nvmet_tcp_queue_mutex);
1961 nvmet_sq_destroy(&queue->nvme_sq);
1963 nvmet_tcp_free_cmd(&queue->connect);
1965 ida_free(&nvmet_tcp_queue_ida, queue->idx);
1967 fput(queue->sock->file);
1971 pr_err("failed to allocate queue, error %d\n", ret);
1973 sock_release(newsock);
1976 static void nvmet_tcp_accept_work(struct work_struct *w)
1978 struct nvmet_tcp_port *port =
1979 container_of(w, struct nvmet_tcp_port, accept_work);
1980 struct socket *newsock;
1984 ret = kernel_accept(port->sock, &newsock, O_NONBLOCK);
1987 pr_warn("failed to accept err=%d\n", ret);
1990 nvmet_tcp_alloc_queue(port, newsock);
1994 static void nvmet_tcp_listen_data_ready(struct sock *sk)
1996 struct nvmet_tcp_port *port;
1998 trace_sk_data_ready(sk);
2000 read_lock_bh(&sk->sk_callback_lock);
2001 port = sk->sk_user_data;
2005 if (sk->sk_state == TCP_LISTEN)
2006 queue_work(nvmet_wq, &port->accept_work);
2008 read_unlock_bh(&sk->sk_callback_lock);
2011 static int nvmet_tcp_add_port(struct nvmet_port *nport)
2013 struct nvmet_tcp_port *port;
2014 __kernel_sa_family_t af;
2017 port = kzalloc(sizeof(*port), GFP_KERNEL);
2021 switch (nport->disc_addr.adrfam) {
2022 case NVMF_ADDR_FAMILY_IP4:
2025 case NVMF_ADDR_FAMILY_IP6:
2029 pr_err("address family %d not supported\n",
2030 nport->disc_addr.adrfam);
2035 ret = inet_pton_with_scope(&init_net, af, nport->disc_addr.traddr,
2036 nport->disc_addr.trsvcid, &port->addr);
2038 pr_err("malformed ip/port passed: %s:%s\n",
2039 nport->disc_addr.traddr, nport->disc_addr.trsvcid);
2043 port->nport = nport;
2044 INIT_WORK(&port->accept_work, nvmet_tcp_accept_work);
2045 if (port->nport->inline_data_size < 0)
2046 port->nport->inline_data_size = NVMET_TCP_DEF_INLINE_DATA_SIZE;
2048 ret = sock_create(port->addr.ss_family, SOCK_STREAM,
2049 IPPROTO_TCP, &port->sock);
2051 pr_err("failed to create a socket\n");
2055 port->sock->sk->sk_user_data = port;
2056 port->data_ready = port->sock->sk->sk_data_ready;
2057 port->sock->sk->sk_data_ready = nvmet_tcp_listen_data_ready;
2058 sock_set_reuseaddr(port->sock->sk);
2059 tcp_sock_set_nodelay(port->sock->sk);
2060 if (so_priority > 0)
2061 sock_set_priority(port->sock->sk, so_priority);
2063 ret = kernel_bind(port->sock, (struct sockaddr *)&port->addr,
2064 sizeof(port->addr));
2066 pr_err("failed to bind port socket %d\n", ret);
2070 ret = kernel_listen(port->sock, NVMET_TCP_BACKLOG);
2072 pr_err("failed to listen %d on port sock\n", ret);
2077 pr_info("enabling port %d (%pISpc)\n",
2078 le16_to_cpu(nport->disc_addr.portid), &port->addr);
2083 sock_release(port->sock);
2089 static void nvmet_tcp_destroy_port_queues(struct nvmet_tcp_port *port)
2091 struct nvmet_tcp_queue *queue;
2093 mutex_lock(&nvmet_tcp_queue_mutex);
2094 list_for_each_entry(queue, &nvmet_tcp_queue_list, queue_list)
2095 if (queue->port == port)
2096 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
2097 mutex_unlock(&nvmet_tcp_queue_mutex);
2100 static void nvmet_tcp_remove_port(struct nvmet_port *nport)
2102 struct nvmet_tcp_port *port = nport->priv;
2104 write_lock_bh(&port->sock->sk->sk_callback_lock);
2105 port->sock->sk->sk_data_ready = port->data_ready;
2106 port->sock->sk->sk_user_data = NULL;
2107 write_unlock_bh(&port->sock->sk->sk_callback_lock);
2108 cancel_work_sync(&port->accept_work);
2110 * Destroy the remaining queues, which are not belong to any
2113 nvmet_tcp_destroy_port_queues(port);
2115 sock_release(port->sock);
2119 static void nvmet_tcp_delete_ctrl(struct nvmet_ctrl *ctrl)
2121 struct nvmet_tcp_queue *queue;
2123 mutex_lock(&nvmet_tcp_queue_mutex);
2124 list_for_each_entry(queue, &nvmet_tcp_queue_list, queue_list)
2125 if (queue->nvme_sq.ctrl == ctrl)
2126 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
2127 mutex_unlock(&nvmet_tcp_queue_mutex);
2130 static u16 nvmet_tcp_install_queue(struct nvmet_sq *sq)
2132 struct nvmet_tcp_queue *queue =
2133 container_of(sq, struct nvmet_tcp_queue, nvme_sq);
2136 struct nvmet_tcp_queue *q;
2139 /* Check for pending controller teardown */
2140 mutex_lock(&nvmet_tcp_queue_mutex);
2141 list_for_each_entry(q, &nvmet_tcp_queue_list, queue_list) {
2142 if (q->nvme_sq.ctrl == sq->ctrl &&
2143 q->state == NVMET_TCP_Q_DISCONNECTING)
2146 mutex_unlock(&nvmet_tcp_queue_mutex);
2147 if (pending > NVMET_TCP_BACKLOG)
2148 return NVME_SC_CONNECT_CTRL_BUSY;
2151 queue->nr_cmds = sq->size * 2;
2152 if (nvmet_tcp_alloc_cmds(queue))
2153 return NVME_SC_INTERNAL;
2157 static void nvmet_tcp_disc_port_addr(struct nvmet_req *req,
2158 struct nvmet_port *nport, char *traddr)
2160 struct nvmet_tcp_port *port = nport->priv;
2162 if (inet_addr_is_any((struct sockaddr *)&port->addr)) {
2163 struct nvmet_tcp_cmd *cmd =
2164 container_of(req, struct nvmet_tcp_cmd, req);
2165 struct nvmet_tcp_queue *queue = cmd->queue;
2167 sprintf(traddr, "%pISc", (struct sockaddr *)&queue->sockaddr);
2169 memcpy(traddr, nport->disc_addr.traddr, NVMF_TRADDR_SIZE);
2173 static const struct nvmet_fabrics_ops nvmet_tcp_ops = {
2174 .owner = THIS_MODULE,
2175 .type = NVMF_TRTYPE_TCP,
2177 .add_port = nvmet_tcp_add_port,
2178 .remove_port = nvmet_tcp_remove_port,
2179 .queue_response = nvmet_tcp_queue_response,
2180 .delete_ctrl = nvmet_tcp_delete_ctrl,
2181 .install_queue = nvmet_tcp_install_queue,
2182 .disc_traddr = nvmet_tcp_disc_port_addr,
2185 static int __init nvmet_tcp_init(void)
2189 nvmet_tcp_wq = alloc_workqueue("nvmet_tcp_wq",
2190 WQ_MEM_RECLAIM | WQ_HIGHPRI, 0);
2194 ret = nvmet_register_transport(&nvmet_tcp_ops);
2200 destroy_workqueue(nvmet_tcp_wq);
2204 static void __exit nvmet_tcp_exit(void)
2206 struct nvmet_tcp_queue *queue;
2208 nvmet_unregister_transport(&nvmet_tcp_ops);
2210 flush_workqueue(nvmet_wq);
2211 mutex_lock(&nvmet_tcp_queue_mutex);
2212 list_for_each_entry(queue, &nvmet_tcp_queue_list, queue_list)
2213 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
2214 mutex_unlock(&nvmet_tcp_queue_mutex);
2215 flush_workqueue(nvmet_wq);
2217 destroy_workqueue(nvmet_tcp_wq);
2218 ida_destroy(&nvmet_tcp_queue_ida);
2221 module_init(nvmet_tcp_init);
2222 module_exit(nvmet_tcp_exit);
2224 MODULE_DESCRIPTION("NVMe target TCP transport driver");
2225 MODULE_LICENSE("GPL v2");
2226 MODULE_ALIAS("nvmet-transport-3"); /* 3 == NVMF_TRTYPE_TCP */