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/nvme-tcp.h>
14 #include <linux/inet.h>
15 #include <linux/llist.h>
16 #include <crypto/hash.h>
17 #include <trace/events/sock.h>
21 #define NVMET_TCP_DEF_INLINE_DATA_SIZE (4 * PAGE_SIZE)
22 #define NVMET_TCP_MAXH2CDATA 0x400000 /* 16M arbitrary limit */
24 static int param_store_val(const char *str, int *val, int min, int max)
28 ret = kstrtoint(str, 10, &new_val);
32 if (new_val < min || new_val > max)
39 static int set_params(const char *str, const struct kernel_param *kp)
41 return param_store_val(str, kp->arg, 0, INT_MAX);
44 static const struct kernel_param_ops set_param_ops = {
49 /* Define the socket priority to use for connections were it is desirable
50 * that the NIC consider performing optimized packet processing or filtering.
51 * A non-zero value being sufficient to indicate general consideration of any
52 * possible optimization. Making it a module param allows for alternative
53 * values that may be unique for some NIC implementations.
55 static int so_priority;
56 device_param_cb(so_priority, &set_param_ops, &so_priority, 0644);
57 MODULE_PARM_DESC(so_priority, "nvmet tcp socket optimize priority: Default 0");
59 /* Define a time period (in usecs) that io_work() shall sample an activated
60 * queue before determining it to be idle. This optional module behavior
61 * can enable NIC solutions that support socket optimized packet processing
62 * using advanced interrupt moderation techniques.
64 static int idle_poll_period_usecs;
65 device_param_cb(idle_poll_period_usecs, &set_param_ops,
66 &idle_poll_period_usecs, 0644);
67 MODULE_PARM_DESC(idle_poll_period_usecs,
68 "nvmet tcp io_work poll till idle time period in usecs: Default 0");
70 #define NVMET_TCP_RECV_BUDGET 8
71 #define NVMET_TCP_SEND_BUDGET 8
72 #define NVMET_TCP_IO_WORK_BUDGET 64
74 enum nvmet_tcp_send_state {
75 NVMET_TCP_SEND_DATA_PDU,
79 NVMET_TCP_SEND_RESPONSE
82 enum nvmet_tcp_recv_state {
90 NVMET_TCP_F_INIT_FAILED = (1 << 0),
93 struct nvmet_tcp_cmd {
94 struct nvmet_tcp_queue *queue;
97 struct nvme_tcp_cmd_pdu *cmd_pdu;
98 struct nvme_tcp_rsp_pdu *rsp_pdu;
99 struct nvme_tcp_data_pdu *data_pdu;
100 struct nvme_tcp_r2t_pdu *r2t_pdu;
108 struct msghdr recv_msg;
112 struct list_head entry;
113 struct llist_node lentry;
117 struct scatterlist *cur_sg;
118 enum nvmet_tcp_send_state state;
124 enum nvmet_tcp_queue_state {
125 NVMET_TCP_Q_CONNECTING,
127 NVMET_TCP_Q_DISCONNECTING,
130 struct nvmet_tcp_queue {
132 struct nvmet_tcp_port *port;
133 struct work_struct io_work;
134 struct nvmet_cq nvme_cq;
135 struct nvmet_sq nvme_sq;
138 struct nvmet_tcp_cmd *cmds;
139 unsigned int nr_cmds;
140 struct list_head free_list;
141 struct llist_head resp_list;
142 struct list_head resp_send_list;
144 struct nvmet_tcp_cmd *snd_cmd;
149 enum nvmet_tcp_recv_state rcv_state;
150 struct nvmet_tcp_cmd *cmd;
151 union nvme_tcp_pdu pdu;
156 struct ahash_request *snd_hash;
157 struct ahash_request *rcv_hash;
159 unsigned long poll_end;
161 spinlock_t state_lock;
162 enum nvmet_tcp_queue_state state;
164 struct sockaddr_storage sockaddr;
165 struct sockaddr_storage sockaddr_peer;
166 struct work_struct release_work;
169 struct list_head queue_list;
171 struct nvmet_tcp_cmd connect;
173 struct page_frag_cache pf_cache;
175 void (*data_ready)(struct sock *);
176 void (*state_change)(struct sock *);
177 void (*write_space)(struct sock *);
180 struct nvmet_tcp_port {
182 struct work_struct accept_work;
183 struct nvmet_port *nport;
184 struct sockaddr_storage addr;
185 void (*data_ready)(struct sock *);
188 static DEFINE_IDA(nvmet_tcp_queue_ida);
189 static LIST_HEAD(nvmet_tcp_queue_list);
190 static DEFINE_MUTEX(nvmet_tcp_queue_mutex);
192 static struct workqueue_struct *nvmet_tcp_wq;
193 static const struct nvmet_fabrics_ops nvmet_tcp_ops;
194 static void nvmet_tcp_free_cmd(struct nvmet_tcp_cmd *c);
195 static void nvmet_tcp_free_cmd_buffers(struct nvmet_tcp_cmd *cmd);
197 static inline u16 nvmet_tcp_cmd_tag(struct nvmet_tcp_queue *queue,
198 struct nvmet_tcp_cmd *cmd)
200 if (unlikely(!queue->nr_cmds)) {
201 /* We didn't allocate cmds yet, send 0xffff */
205 return cmd - queue->cmds;
208 static inline bool nvmet_tcp_has_data_in(struct nvmet_tcp_cmd *cmd)
210 return nvme_is_write(cmd->req.cmd) &&
211 cmd->rbytes_done < cmd->req.transfer_len;
214 static inline bool nvmet_tcp_need_data_in(struct nvmet_tcp_cmd *cmd)
216 return nvmet_tcp_has_data_in(cmd) && !cmd->req.cqe->status;
219 static inline bool nvmet_tcp_need_data_out(struct nvmet_tcp_cmd *cmd)
221 return !nvme_is_write(cmd->req.cmd) &&
222 cmd->req.transfer_len > 0 &&
223 !cmd->req.cqe->status;
226 static inline bool nvmet_tcp_has_inline_data(struct nvmet_tcp_cmd *cmd)
228 return nvme_is_write(cmd->req.cmd) && cmd->pdu_len &&
232 static inline struct nvmet_tcp_cmd *
233 nvmet_tcp_get_cmd(struct nvmet_tcp_queue *queue)
235 struct nvmet_tcp_cmd *cmd;
237 cmd = list_first_entry_or_null(&queue->free_list,
238 struct nvmet_tcp_cmd, entry);
241 list_del_init(&cmd->entry);
243 cmd->rbytes_done = cmd->wbytes_done = 0;
251 static inline void nvmet_tcp_put_cmd(struct nvmet_tcp_cmd *cmd)
253 if (unlikely(cmd == &cmd->queue->connect))
256 list_add_tail(&cmd->entry, &cmd->queue->free_list);
259 static inline int queue_cpu(struct nvmet_tcp_queue *queue)
261 return queue->sock->sk->sk_incoming_cpu;
264 static inline u8 nvmet_tcp_hdgst_len(struct nvmet_tcp_queue *queue)
266 return queue->hdr_digest ? NVME_TCP_DIGEST_LENGTH : 0;
269 static inline u8 nvmet_tcp_ddgst_len(struct nvmet_tcp_queue *queue)
271 return queue->data_digest ? NVME_TCP_DIGEST_LENGTH : 0;
274 static inline void nvmet_tcp_hdgst(struct ahash_request *hash,
275 void *pdu, size_t len)
277 struct scatterlist sg;
279 sg_init_one(&sg, pdu, len);
280 ahash_request_set_crypt(hash, &sg, pdu + len, len);
281 crypto_ahash_digest(hash);
284 static int nvmet_tcp_verify_hdgst(struct nvmet_tcp_queue *queue,
285 void *pdu, size_t len)
287 struct nvme_tcp_hdr *hdr = pdu;
291 if (unlikely(!(hdr->flags & NVME_TCP_F_HDGST))) {
292 pr_err("queue %d: header digest enabled but no header digest\n",
297 recv_digest = *(__le32 *)(pdu + hdr->hlen);
298 nvmet_tcp_hdgst(queue->rcv_hash, pdu, len);
299 exp_digest = *(__le32 *)(pdu + hdr->hlen);
300 if (recv_digest != exp_digest) {
301 pr_err("queue %d: header digest error: recv %#x expected %#x\n",
302 queue->idx, le32_to_cpu(recv_digest),
303 le32_to_cpu(exp_digest));
310 static int nvmet_tcp_check_ddgst(struct nvmet_tcp_queue *queue, void *pdu)
312 struct nvme_tcp_hdr *hdr = pdu;
313 u8 digest_len = nvmet_tcp_hdgst_len(queue);
316 len = le32_to_cpu(hdr->plen) - hdr->hlen -
317 (hdr->flags & NVME_TCP_F_HDGST ? digest_len : 0);
319 if (unlikely(len && !(hdr->flags & NVME_TCP_F_DDGST))) {
320 pr_err("queue %d: data digest flag is cleared\n", queue->idx);
327 static void nvmet_tcp_free_cmd_buffers(struct nvmet_tcp_cmd *cmd)
330 sgl_free(cmd->req.sg);
335 static void nvmet_tcp_build_pdu_iovec(struct nvmet_tcp_cmd *cmd)
337 struct bio_vec *iov = cmd->iov;
338 struct scatterlist *sg;
339 u32 length, offset, sg_offset;
342 length = cmd->pdu_len;
343 nr_pages = DIV_ROUND_UP(length, PAGE_SIZE);
344 offset = cmd->rbytes_done;
345 cmd->sg_idx = offset / PAGE_SIZE;
346 sg_offset = offset % PAGE_SIZE;
347 sg = &cmd->req.sg[cmd->sg_idx];
350 u32 iov_len = min_t(u32, length, sg->length - sg_offset);
352 bvec_set_page(iov, sg_page(sg), iov_len,
353 sg->offset + sg_offset);
361 iov_iter_bvec(&cmd->recv_msg.msg_iter, ITER_DEST, cmd->iov,
362 nr_pages, cmd->pdu_len);
365 static void nvmet_tcp_fatal_error(struct nvmet_tcp_queue *queue)
367 queue->rcv_state = NVMET_TCP_RECV_ERR;
368 if (queue->nvme_sq.ctrl)
369 nvmet_ctrl_fatal_error(queue->nvme_sq.ctrl);
371 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
374 static void nvmet_tcp_socket_error(struct nvmet_tcp_queue *queue, int status)
376 queue->rcv_state = NVMET_TCP_RECV_ERR;
377 if (status == -EPIPE || status == -ECONNRESET)
378 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
380 nvmet_tcp_fatal_error(queue);
383 static int nvmet_tcp_map_data(struct nvmet_tcp_cmd *cmd)
385 struct nvme_sgl_desc *sgl = &cmd->req.cmd->common.dptr.sgl;
386 u32 len = le32_to_cpu(sgl->length);
391 if (sgl->type == ((NVME_SGL_FMT_DATA_DESC << 4) |
392 NVME_SGL_FMT_OFFSET)) {
393 if (!nvme_is_write(cmd->req.cmd))
394 return NVME_SC_INVALID_FIELD | NVME_SC_DNR;
396 if (len > cmd->req.port->inline_data_size)
397 return NVME_SC_SGL_INVALID_OFFSET | NVME_SC_DNR;
400 cmd->req.transfer_len += len;
402 cmd->req.sg = sgl_alloc(len, GFP_KERNEL, &cmd->req.sg_cnt);
404 return NVME_SC_INTERNAL;
405 cmd->cur_sg = cmd->req.sg;
407 if (nvmet_tcp_has_data_in(cmd)) {
408 cmd->iov = kmalloc_array(cmd->req.sg_cnt,
409 sizeof(*cmd->iov), GFP_KERNEL);
416 nvmet_tcp_free_cmd_buffers(cmd);
417 return NVME_SC_INTERNAL;
420 static void nvmet_tcp_calc_ddgst(struct ahash_request *hash,
421 struct nvmet_tcp_cmd *cmd)
423 ahash_request_set_crypt(hash, cmd->req.sg,
424 (void *)&cmd->exp_ddgst, cmd->req.transfer_len);
425 crypto_ahash_digest(hash);
428 static void nvmet_setup_c2h_data_pdu(struct nvmet_tcp_cmd *cmd)
430 struct nvme_tcp_data_pdu *pdu = cmd->data_pdu;
431 struct nvmet_tcp_queue *queue = cmd->queue;
432 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
433 u8 ddgst = nvmet_tcp_ddgst_len(cmd->queue);
436 cmd->state = NVMET_TCP_SEND_DATA_PDU;
438 pdu->hdr.type = nvme_tcp_c2h_data;
439 pdu->hdr.flags = NVME_TCP_F_DATA_LAST | (queue->nvme_sq.sqhd_disabled ?
440 NVME_TCP_F_DATA_SUCCESS : 0);
441 pdu->hdr.hlen = sizeof(*pdu);
442 pdu->hdr.pdo = pdu->hdr.hlen + hdgst;
444 cpu_to_le32(pdu->hdr.hlen + hdgst +
445 cmd->req.transfer_len + ddgst);
446 pdu->command_id = cmd->req.cqe->command_id;
447 pdu->data_length = cpu_to_le32(cmd->req.transfer_len);
448 pdu->data_offset = cpu_to_le32(cmd->wbytes_done);
450 if (queue->data_digest) {
451 pdu->hdr.flags |= NVME_TCP_F_DDGST;
452 nvmet_tcp_calc_ddgst(queue->snd_hash, cmd);
455 if (cmd->queue->hdr_digest) {
456 pdu->hdr.flags |= NVME_TCP_F_HDGST;
457 nvmet_tcp_hdgst(queue->snd_hash, pdu, sizeof(*pdu));
461 static void nvmet_setup_r2t_pdu(struct nvmet_tcp_cmd *cmd)
463 struct nvme_tcp_r2t_pdu *pdu = cmd->r2t_pdu;
464 struct nvmet_tcp_queue *queue = cmd->queue;
465 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
468 cmd->state = NVMET_TCP_SEND_R2T;
470 pdu->hdr.type = nvme_tcp_r2t;
472 pdu->hdr.hlen = sizeof(*pdu);
474 pdu->hdr.plen = cpu_to_le32(pdu->hdr.hlen + hdgst);
476 pdu->command_id = cmd->req.cmd->common.command_id;
477 pdu->ttag = nvmet_tcp_cmd_tag(cmd->queue, cmd);
478 pdu->r2t_length = cpu_to_le32(cmd->req.transfer_len - cmd->rbytes_done);
479 pdu->r2t_offset = cpu_to_le32(cmd->rbytes_done);
480 if (cmd->queue->hdr_digest) {
481 pdu->hdr.flags |= NVME_TCP_F_HDGST;
482 nvmet_tcp_hdgst(queue->snd_hash, pdu, sizeof(*pdu));
486 static void nvmet_setup_response_pdu(struct nvmet_tcp_cmd *cmd)
488 struct nvme_tcp_rsp_pdu *pdu = cmd->rsp_pdu;
489 struct nvmet_tcp_queue *queue = cmd->queue;
490 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
493 cmd->state = NVMET_TCP_SEND_RESPONSE;
495 pdu->hdr.type = nvme_tcp_rsp;
497 pdu->hdr.hlen = sizeof(*pdu);
499 pdu->hdr.plen = cpu_to_le32(pdu->hdr.hlen + hdgst);
500 if (cmd->queue->hdr_digest) {
501 pdu->hdr.flags |= NVME_TCP_F_HDGST;
502 nvmet_tcp_hdgst(queue->snd_hash, pdu, sizeof(*pdu));
506 static void nvmet_tcp_process_resp_list(struct nvmet_tcp_queue *queue)
508 struct llist_node *node;
509 struct nvmet_tcp_cmd *cmd;
511 for (node = llist_del_all(&queue->resp_list); node; node = node->next) {
512 cmd = llist_entry(node, struct nvmet_tcp_cmd, lentry);
513 list_add(&cmd->entry, &queue->resp_send_list);
514 queue->send_list_len++;
518 static struct nvmet_tcp_cmd *nvmet_tcp_fetch_cmd(struct nvmet_tcp_queue *queue)
520 queue->snd_cmd = list_first_entry_or_null(&queue->resp_send_list,
521 struct nvmet_tcp_cmd, entry);
522 if (!queue->snd_cmd) {
523 nvmet_tcp_process_resp_list(queue);
525 list_first_entry_or_null(&queue->resp_send_list,
526 struct nvmet_tcp_cmd, entry);
527 if (unlikely(!queue->snd_cmd))
531 list_del_init(&queue->snd_cmd->entry);
532 queue->send_list_len--;
534 if (nvmet_tcp_need_data_out(queue->snd_cmd))
535 nvmet_setup_c2h_data_pdu(queue->snd_cmd);
536 else if (nvmet_tcp_need_data_in(queue->snd_cmd))
537 nvmet_setup_r2t_pdu(queue->snd_cmd);
539 nvmet_setup_response_pdu(queue->snd_cmd);
541 return queue->snd_cmd;
544 static void nvmet_tcp_queue_response(struct nvmet_req *req)
546 struct nvmet_tcp_cmd *cmd =
547 container_of(req, struct nvmet_tcp_cmd, req);
548 struct nvmet_tcp_queue *queue = cmd->queue;
549 struct nvme_sgl_desc *sgl;
552 if (unlikely(cmd == queue->cmd)) {
553 sgl = &cmd->req.cmd->common.dptr.sgl;
554 len = le32_to_cpu(sgl->length);
557 * Wait for inline data before processing the response.
558 * Avoid using helpers, this might happen before
559 * nvmet_req_init is completed.
561 if (queue->rcv_state == NVMET_TCP_RECV_PDU &&
562 len && len <= cmd->req.port->inline_data_size &&
563 nvme_is_write(cmd->req.cmd))
567 llist_add(&cmd->lentry, &queue->resp_list);
568 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &cmd->queue->io_work);
571 static void nvmet_tcp_execute_request(struct nvmet_tcp_cmd *cmd)
573 if (unlikely(cmd->flags & NVMET_TCP_F_INIT_FAILED))
574 nvmet_tcp_queue_response(&cmd->req);
576 cmd->req.execute(&cmd->req);
579 static int nvmet_try_send_data_pdu(struct nvmet_tcp_cmd *cmd)
581 struct msghdr msg = {
582 .msg_flags = MSG_DONTWAIT | MSG_MORE | MSG_SPLICE_PAGES,
585 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
586 int left = sizeof(*cmd->data_pdu) - cmd->offset + hdgst;
589 bvec_set_virt(&bvec, (void *)cmd->data_pdu + cmd->offset, left);
590 iov_iter_bvec(&msg.msg_iter, ITER_SOURCE, &bvec, 1, left);
591 ret = sock_sendmsg(cmd->queue->sock, &msg);
601 cmd->state = NVMET_TCP_SEND_DATA;
606 static int nvmet_try_send_data(struct nvmet_tcp_cmd *cmd, bool last_in_batch)
608 struct nvmet_tcp_queue *queue = cmd->queue;
611 while (cmd->cur_sg) {
612 struct msghdr msg = {
613 .msg_flags = MSG_DONTWAIT | MSG_SPLICE_PAGES,
615 struct page *page = sg_page(cmd->cur_sg);
617 u32 left = cmd->cur_sg->length - cmd->offset;
619 if ((!last_in_batch && cmd->queue->send_list_len) ||
620 cmd->wbytes_done + left < cmd->req.transfer_len ||
621 queue->data_digest || !queue->nvme_sq.sqhd_disabled)
622 msg.msg_flags |= MSG_MORE;
624 bvec_set_page(&bvec, page, left, cmd->offset);
625 iov_iter_bvec(&msg.msg_iter, ITER_SOURCE, &bvec, 1, left);
626 ret = sock_sendmsg(cmd->queue->sock, &msg);
631 cmd->wbytes_done += ret;
634 if (cmd->offset == cmd->cur_sg->length) {
635 cmd->cur_sg = sg_next(cmd->cur_sg);
640 if (queue->data_digest) {
641 cmd->state = NVMET_TCP_SEND_DDGST;
644 if (queue->nvme_sq.sqhd_disabled) {
645 cmd->queue->snd_cmd = NULL;
646 nvmet_tcp_put_cmd(cmd);
648 nvmet_setup_response_pdu(cmd);
652 if (queue->nvme_sq.sqhd_disabled)
653 nvmet_tcp_free_cmd_buffers(cmd);
659 static int nvmet_try_send_response(struct nvmet_tcp_cmd *cmd,
662 struct msghdr msg = { .msg_flags = MSG_DONTWAIT | MSG_SPLICE_PAGES, };
664 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
665 int left = sizeof(*cmd->rsp_pdu) - cmd->offset + hdgst;
668 if (!last_in_batch && cmd->queue->send_list_len)
669 msg.msg_flags |= MSG_MORE;
671 msg.msg_flags |= MSG_EOR;
673 bvec_set_virt(&bvec, (void *)cmd->rsp_pdu + cmd->offset, left);
674 iov_iter_bvec(&msg.msg_iter, ITER_SOURCE, &bvec, 1, left);
675 ret = sock_sendmsg(cmd->queue->sock, &msg);
684 nvmet_tcp_free_cmd_buffers(cmd);
685 cmd->queue->snd_cmd = NULL;
686 nvmet_tcp_put_cmd(cmd);
690 static int nvmet_try_send_r2t(struct nvmet_tcp_cmd *cmd, bool last_in_batch)
692 struct msghdr msg = { .msg_flags = MSG_DONTWAIT | MSG_SPLICE_PAGES, };
694 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
695 int left = sizeof(*cmd->r2t_pdu) - cmd->offset + hdgst;
698 if (!last_in_batch && cmd->queue->send_list_len)
699 msg.msg_flags |= MSG_MORE;
701 msg.msg_flags |= MSG_EOR;
703 bvec_set_virt(&bvec, (void *)cmd->r2t_pdu + cmd->offset, left);
704 iov_iter_bvec(&msg.msg_iter, ITER_SOURCE, &bvec, 1, left);
705 ret = sock_sendmsg(cmd->queue->sock, &msg);
714 cmd->queue->snd_cmd = NULL;
718 static int nvmet_try_send_ddgst(struct nvmet_tcp_cmd *cmd, bool last_in_batch)
720 struct nvmet_tcp_queue *queue = cmd->queue;
721 int left = NVME_TCP_DIGEST_LENGTH - cmd->offset;
722 struct msghdr msg = { .msg_flags = MSG_DONTWAIT };
724 .iov_base = (u8 *)&cmd->exp_ddgst + cmd->offset,
729 if (!last_in_batch && cmd->queue->send_list_len)
730 msg.msg_flags |= MSG_MORE;
732 msg.msg_flags |= MSG_EOR;
734 ret = kernel_sendmsg(queue->sock, &msg, &iov, 1, iov.iov_len);
735 if (unlikely(ret <= 0))
744 if (queue->nvme_sq.sqhd_disabled) {
745 cmd->queue->snd_cmd = NULL;
746 nvmet_tcp_put_cmd(cmd);
748 nvmet_setup_response_pdu(cmd);
753 static int nvmet_tcp_try_send_one(struct nvmet_tcp_queue *queue,
756 struct nvmet_tcp_cmd *cmd = queue->snd_cmd;
759 if (!cmd || queue->state == NVMET_TCP_Q_DISCONNECTING) {
760 cmd = nvmet_tcp_fetch_cmd(queue);
765 if (cmd->state == NVMET_TCP_SEND_DATA_PDU) {
766 ret = nvmet_try_send_data_pdu(cmd);
771 if (cmd->state == NVMET_TCP_SEND_DATA) {
772 ret = nvmet_try_send_data(cmd, last_in_batch);
777 if (cmd->state == NVMET_TCP_SEND_DDGST) {
778 ret = nvmet_try_send_ddgst(cmd, last_in_batch);
783 if (cmd->state == NVMET_TCP_SEND_R2T) {
784 ret = nvmet_try_send_r2t(cmd, last_in_batch);
789 if (cmd->state == NVMET_TCP_SEND_RESPONSE)
790 ret = nvmet_try_send_response(cmd, last_in_batch);
802 static int nvmet_tcp_try_send(struct nvmet_tcp_queue *queue,
803 int budget, int *sends)
807 for (i = 0; i < budget; i++) {
808 ret = nvmet_tcp_try_send_one(queue, i == budget - 1);
809 if (unlikely(ret < 0)) {
810 nvmet_tcp_socket_error(queue, ret);
812 } else if (ret == 0) {
821 static void nvmet_prepare_receive_pdu(struct nvmet_tcp_queue *queue)
824 queue->left = sizeof(struct nvme_tcp_hdr);
826 queue->rcv_state = NVMET_TCP_RECV_PDU;
829 static void nvmet_tcp_free_crypto(struct nvmet_tcp_queue *queue)
831 struct crypto_ahash *tfm = crypto_ahash_reqtfm(queue->rcv_hash);
833 ahash_request_free(queue->rcv_hash);
834 ahash_request_free(queue->snd_hash);
835 crypto_free_ahash(tfm);
838 static int nvmet_tcp_alloc_crypto(struct nvmet_tcp_queue *queue)
840 struct crypto_ahash *tfm;
842 tfm = crypto_alloc_ahash("crc32c", 0, CRYPTO_ALG_ASYNC);
846 queue->snd_hash = ahash_request_alloc(tfm, GFP_KERNEL);
847 if (!queue->snd_hash)
849 ahash_request_set_callback(queue->snd_hash, 0, NULL, NULL);
851 queue->rcv_hash = ahash_request_alloc(tfm, GFP_KERNEL);
852 if (!queue->rcv_hash)
854 ahash_request_set_callback(queue->rcv_hash, 0, NULL, NULL);
858 ahash_request_free(queue->snd_hash);
860 crypto_free_ahash(tfm);
865 static int nvmet_tcp_handle_icreq(struct nvmet_tcp_queue *queue)
867 struct nvme_tcp_icreq_pdu *icreq = &queue->pdu.icreq;
868 struct nvme_tcp_icresp_pdu *icresp = &queue->pdu.icresp;
869 struct msghdr msg = {};
873 if (le32_to_cpu(icreq->hdr.plen) != sizeof(struct nvme_tcp_icreq_pdu)) {
874 pr_err("bad nvme-tcp pdu length (%d)\n",
875 le32_to_cpu(icreq->hdr.plen));
876 nvmet_tcp_fatal_error(queue);
879 if (icreq->pfv != NVME_TCP_PFV_1_0) {
880 pr_err("queue %d: bad pfv %d\n", queue->idx, icreq->pfv);
884 if (icreq->hpda != 0) {
885 pr_err("queue %d: unsupported hpda %d\n", queue->idx,
890 queue->hdr_digest = !!(icreq->digest & NVME_TCP_HDR_DIGEST_ENABLE);
891 queue->data_digest = !!(icreq->digest & NVME_TCP_DATA_DIGEST_ENABLE);
892 if (queue->hdr_digest || queue->data_digest) {
893 ret = nvmet_tcp_alloc_crypto(queue);
898 memset(icresp, 0, sizeof(*icresp));
899 icresp->hdr.type = nvme_tcp_icresp;
900 icresp->hdr.hlen = sizeof(*icresp);
902 icresp->hdr.plen = cpu_to_le32(icresp->hdr.hlen);
903 icresp->pfv = cpu_to_le16(NVME_TCP_PFV_1_0);
904 icresp->maxdata = cpu_to_le32(NVMET_TCP_MAXH2CDATA);
906 if (queue->hdr_digest)
907 icresp->digest |= NVME_TCP_HDR_DIGEST_ENABLE;
908 if (queue->data_digest)
909 icresp->digest |= NVME_TCP_DATA_DIGEST_ENABLE;
911 iov.iov_base = icresp;
912 iov.iov_len = sizeof(*icresp);
913 ret = kernel_sendmsg(queue->sock, &msg, &iov, 1, iov.iov_len);
915 return ret; /* queue removal will cleanup */
917 queue->state = NVMET_TCP_Q_LIVE;
918 nvmet_prepare_receive_pdu(queue);
922 static void nvmet_tcp_handle_req_failure(struct nvmet_tcp_queue *queue,
923 struct nvmet_tcp_cmd *cmd, struct nvmet_req *req)
925 size_t data_len = le32_to_cpu(req->cmd->common.dptr.sgl.length);
929 * This command has not been processed yet, hence we are trying to
930 * figure out if there is still pending data left to receive. If
931 * we don't, we can simply prepare for the next pdu and bail out,
932 * otherwise we will need to prepare a buffer and receive the
933 * stale data before continuing forward.
935 if (!nvme_is_write(cmd->req.cmd) || !data_len ||
936 data_len > cmd->req.port->inline_data_size) {
937 nvmet_prepare_receive_pdu(queue);
941 ret = nvmet_tcp_map_data(cmd);
943 pr_err("queue %d: failed to map data\n", queue->idx);
944 nvmet_tcp_fatal_error(queue);
948 queue->rcv_state = NVMET_TCP_RECV_DATA;
949 nvmet_tcp_build_pdu_iovec(cmd);
950 cmd->flags |= NVMET_TCP_F_INIT_FAILED;
953 static int nvmet_tcp_handle_h2c_data_pdu(struct nvmet_tcp_queue *queue)
955 struct nvme_tcp_data_pdu *data = &queue->pdu.data;
956 struct nvmet_tcp_cmd *cmd;
959 if (likely(queue->nr_cmds)) {
960 if (unlikely(data->ttag >= queue->nr_cmds)) {
961 pr_err("queue %d: received out of bound ttag %u, nr_cmds %u\n",
962 queue->idx, data->ttag, queue->nr_cmds);
963 nvmet_tcp_fatal_error(queue);
966 cmd = &queue->cmds[data->ttag];
968 cmd = &queue->connect;
971 if (le32_to_cpu(data->data_offset) != cmd->rbytes_done) {
972 pr_err("ttag %u unexpected data offset %u (expected %u)\n",
973 data->ttag, le32_to_cpu(data->data_offset),
975 /* FIXME: use path and transport errors */
976 nvmet_tcp_fatal_error(queue);
980 plen = le32_to_cpu(data->hdr.plen);
981 cmd->pdu_len = le32_to_cpu(data->data_length);
982 if (unlikely(cmd->pdu_len != (plen - sizeof(*data)) ||
984 cmd->pdu_len > NVMET_TCP_MAXH2CDATA)) {
985 pr_err("H2CData PDU len %u is invalid\n", cmd->pdu_len);
986 /* FIXME: use proper transport errors */
987 nvmet_tcp_fatal_error(queue);
991 nvmet_tcp_build_pdu_iovec(cmd);
993 queue->rcv_state = NVMET_TCP_RECV_DATA;
998 static int nvmet_tcp_done_recv_pdu(struct nvmet_tcp_queue *queue)
1000 struct nvme_tcp_hdr *hdr = &queue->pdu.cmd.hdr;
1001 struct nvme_command *nvme_cmd = &queue->pdu.cmd.cmd;
1002 struct nvmet_req *req;
1005 if (unlikely(queue->state == NVMET_TCP_Q_CONNECTING)) {
1006 if (hdr->type != nvme_tcp_icreq) {
1007 pr_err("unexpected pdu type (%d) before icreq\n",
1009 nvmet_tcp_fatal_error(queue);
1012 return nvmet_tcp_handle_icreq(queue);
1015 if (unlikely(hdr->type == nvme_tcp_icreq)) {
1016 pr_err("queue %d: received icreq pdu in state %d\n",
1017 queue->idx, queue->state);
1018 nvmet_tcp_fatal_error(queue);
1022 if (hdr->type == nvme_tcp_h2c_data) {
1023 ret = nvmet_tcp_handle_h2c_data_pdu(queue);
1029 queue->cmd = nvmet_tcp_get_cmd(queue);
1030 if (unlikely(!queue->cmd)) {
1031 /* This should never happen */
1032 pr_err("queue %d: out of commands (%d) send_list_len: %d, opcode: %d",
1033 queue->idx, queue->nr_cmds, queue->send_list_len,
1034 nvme_cmd->common.opcode);
1035 nvmet_tcp_fatal_error(queue);
1039 req = &queue->cmd->req;
1040 memcpy(req->cmd, nvme_cmd, sizeof(*nvme_cmd));
1042 if (unlikely(!nvmet_req_init(req, &queue->nvme_cq,
1043 &queue->nvme_sq, &nvmet_tcp_ops))) {
1044 pr_err("failed cmd %p id %d opcode %d, data_len: %d\n",
1045 req->cmd, req->cmd->common.command_id,
1046 req->cmd->common.opcode,
1047 le32_to_cpu(req->cmd->common.dptr.sgl.length));
1049 nvmet_tcp_handle_req_failure(queue, queue->cmd, req);
1053 ret = nvmet_tcp_map_data(queue->cmd);
1054 if (unlikely(ret)) {
1055 pr_err("queue %d: failed to map data\n", queue->idx);
1056 if (nvmet_tcp_has_inline_data(queue->cmd))
1057 nvmet_tcp_fatal_error(queue);
1059 nvmet_req_complete(req, ret);
1064 if (nvmet_tcp_need_data_in(queue->cmd)) {
1065 if (nvmet_tcp_has_inline_data(queue->cmd)) {
1066 queue->rcv_state = NVMET_TCP_RECV_DATA;
1067 nvmet_tcp_build_pdu_iovec(queue->cmd);
1071 nvmet_tcp_queue_response(&queue->cmd->req);
1075 queue->cmd->req.execute(&queue->cmd->req);
1077 nvmet_prepare_receive_pdu(queue);
1081 static const u8 nvme_tcp_pdu_sizes[] = {
1082 [nvme_tcp_icreq] = sizeof(struct nvme_tcp_icreq_pdu),
1083 [nvme_tcp_cmd] = sizeof(struct nvme_tcp_cmd_pdu),
1084 [nvme_tcp_h2c_data] = sizeof(struct nvme_tcp_data_pdu),
1087 static inline u8 nvmet_tcp_pdu_size(u8 type)
1091 return (idx < ARRAY_SIZE(nvme_tcp_pdu_sizes) &&
1092 nvme_tcp_pdu_sizes[idx]) ?
1093 nvme_tcp_pdu_sizes[idx] : 0;
1096 static inline bool nvmet_tcp_pdu_valid(u8 type)
1099 case nvme_tcp_icreq:
1101 case nvme_tcp_h2c_data:
1109 static int nvmet_tcp_try_recv_pdu(struct nvmet_tcp_queue *queue)
1111 struct nvme_tcp_hdr *hdr = &queue->pdu.cmd.hdr;
1114 struct msghdr msg = { .msg_flags = MSG_DONTWAIT };
1117 iov.iov_base = (void *)&queue->pdu + queue->offset;
1118 iov.iov_len = queue->left;
1119 len = kernel_recvmsg(queue->sock, &msg, &iov, 1,
1120 iov.iov_len, msg.msg_flags);
1121 if (unlikely(len < 0))
1124 queue->offset += len;
1129 if (queue->offset == sizeof(struct nvme_tcp_hdr)) {
1130 u8 hdgst = nvmet_tcp_hdgst_len(queue);
1132 if (unlikely(!nvmet_tcp_pdu_valid(hdr->type))) {
1133 pr_err("unexpected pdu type %d\n", hdr->type);
1134 nvmet_tcp_fatal_error(queue);
1138 if (unlikely(hdr->hlen != nvmet_tcp_pdu_size(hdr->type))) {
1139 pr_err("pdu %d bad hlen %d\n", hdr->type, hdr->hlen);
1143 queue->left = hdr->hlen - queue->offset + hdgst;
1147 if (queue->hdr_digest &&
1148 nvmet_tcp_verify_hdgst(queue, &queue->pdu, hdr->hlen)) {
1149 nvmet_tcp_fatal_error(queue); /* fatal */
1153 if (queue->data_digest &&
1154 nvmet_tcp_check_ddgst(queue, &queue->pdu)) {
1155 nvmet_tcp_fatal_error(queue); /* fatal */
1159 return nvmet_tcp_done_recv_pdu(queue);
1162 static void nvmet_tcp_prep_recv_ddgst(struct nvmet_tcp_cmd *cmd)
1164 struct nvmet_tcp_queue *queue = cmd->queue;
1166 nvmet_tcp_calc_ddgst(queue->rcv_hash, cmd);
1168 queue->left = NVME_TCP_DIGEST_LENGTH;
1169 queue->rcv_state = NVMET_TCP_RECV_DDGST;
1172 static int nvmet_tcp_try_recv_data(struct nvmet_tcp_queue *queue)
1174 struct nvmet_tcp_cmd *cmd = queue->cmd;
1177 while (msg_data_left(&cmd->recv_msg)) {
1178 ret = sock_recvmsg(cmd->queue->sock, &cmd->recv_msg,
1179 cmd->recv_msg.msg_flags);
1183 cmd->pdu_recv += ret;
1184 cmd->rbytes_done += ret;
1187 if (queue->data_digest) {
1188 nvmet_tcp_prep_recv_ddgst(cmd);
1192 if (cmd->rbytes_done == cmd->req.transfer_len)
1193 nvmet_tcp_execute_request(cmd);
1195 nvmet_prepare_receive_pdu(queue);
1199 static int nvmet_tcp_try_recv_ddgst(struct nvmet_tcp_queue *queue)
1201 struct nvmet_tcp_cmd *cmd = queue->cmd;
1203 struct msghdr msg = { .msg_flags = MSG_DONTWAIT };
1205 .iov_base = (void *)&cmd->recv_ddgst + queue->offset,
1206 .iov_len = queue->left
1209 ret = kernel_recvmsg(queue->sock, &msg, &iov, 1,
1210 iov.iov_len, msg.msg_flags);
1211 if (unlikely(ret < 0))
1214 queue->offset += ret;
1219 if (queue->data_digest && cmd->exp_ddgst != cmd->recv_ddgst) {
1220 pr_err("queue %d: cmd %d pdu (%d) data digest error: recv %#x expected %#x\n",
1221 queue->idx, cmd->req.cmd->common.command_id,
1222 queue->pdu.cmd.hdr.type, le32_to_cpu(cmd->recv_ddgst),
1223 le32_to_cpu(cmd->exp_ddgst));
1224 nvmet_req_uninit(&cmd->req);
1225 nvmet_tcp_free_cmd_buffers(cmd);
1226 nvmet_tcp_fatal_error(queue);
1231 if (cmd->rbytes_done == cmd->req.transfer_len)
1232 nvmet_tcp_execute_request(cmd);
1236 nvmet_prepare_receive_pdu(queue);
1240 static int nvmet_tcp_try_recv_one(struct nvmet_tcp_queue *queue)
1244 if (unlikely(queue->rcv_state == NVMET_TCP_RECV_ERR))
1247 if (queue->rcv_state == NVMET_TCP_RECV_PDU) {
1248 result = nvmet_tcp_try_recv_pdu(queue);
1253 if (queue->rcv_state == NVMET_TCP_RECV_DATA) {
1254 result = nvmet_tcp_try_recv_data(queue);
1259 if (queue->rcv_state == NVMET_TCP_RECV_DDGST) {
1260 result = nvmet_tcp_try_recv_ddgst(queue);
1267 if (result == -EAGAIN)
1274 static int nvmet_tcp_try_recv(struct nvmet_tcp_queue *queue,
1275 int budget, int *recvs)
1279 for (i = 0; i < budget; i++) {
1280 ret = nvmet_tcp_try_recv_one(queue);
1281 if (unlikely(ret < 0)) {
1282 nvmet_tcp_socket_error(queue, ret);
1284 } else if (ret == 0) {
1293 static void nvmet_tcp_schedule_release_queue(struct nvmet_tcp_queue *queue)
1295 spin_lock(&queue->state_lock);
1296 if (queue->state != NVMET_TCP_Q_DISCONNECTING) {
1297 queue->state = NVMET_TCP_Q_DISCONNECTING;
1298 queue_work(nvmet_wq, &queue->release_work);
1300 spin_unlock(&queue->state_lock);
1303 static inline void nvmet_tcp_arm_queue_deadline(struct nvmet_tcp_queue *queue)
1305 queue->poll_end = jiffies + usecs_to_jiffies(idle_poll_period_usecs);
1308 static bool nvmet_tcp_check_queue_deadline(struct nvmet_tcp_queue *queue,
1311 if (!idle_poll_period_usecs)
1315 nvmet_tcp_arm_queue_deadline(queue);
1317 return !time_after(jiffies, queue->poll_end);
1320 static void nvmet_tcp_io_work(struct work_struct *w)
1322 struct nvmet_tcp_queue *queue =
1323 container_of(w, struct nvmet_tcp_queue, io_work);
1330 ret = nvmet_tcp_try_recv(queue, NVMET_TCP_RECV_BUDGET, &ops);
1336 ret = nvmet_tcp_try_send(queue, NVMET_TCP_SEND_BUDGET, &ops);
1342 } while (pending && ops < NVMET_TCP_IO_WORK_BUDGET);
1345 * Requeue the worker if idle deadline period is in progress or any
1346 * ops activity was recorded during the do-while loop above.
1348 if (nvmet_tcp_check_queue_deadline(queue, ops) || pending)
1349 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &queue->io_work);
1352 static int nvmet_tcp_alloc_cmd(struct nvmet_tcp_queue *queue,
1353 struct nvmet_tcp_cmd *c)
1355 u8 hdgst = nvmet_tcp_hdgst_len(queue);
1358 c->req.port = queue->port->nport;
1360 c->cmd_pdu = page_frag_alloc(&queue->pf_cache,
1361 sizeof(*c->cmd_pdu) + hdgst, GFP_KERNEL | __GFP_ZERO);
1364 c->req.cmd = &c->cmd_pdu->cmd;
1366 c->rsp_pdu = page_frag_alloc(&queue->pf_cache,
1367 sizeof(*c->rsp_pdu) + hdgst, GFP_KERNEL | __GFP_ZERO);
1370 c->req.cqe = &c->rsp_pdu->cqe;
1372 c->data_pdu = page_frag_alloc(&queue->pf_cache,
1373 sizeof(*c->data_pdu) + hdgst, GFP_KERNEL | __GFP_ZERO);
1377 c->r2t_pdu = page_frag_alloc(&queue->pf_cache,
1378 sizeof(*c->r2t_pdu) + hdgst, GFP_KERNEL | __GFP_ZERO);
1382 c->recv_msg.msg_flags = MSG_DONTWAIT | MSG_NOSIGNAL;
1384 list_add_tail(&c->entry, &queue->free_list);
1388 page_frag_free(c->data_pdu);
1390 page_frag_free(c->rsp_pdu);
1392 page_frag_free(c->cmd_pdu);
1396 static void nvmet_tcp_free_cmd(struct nvmet_tcp_cmd *c)
1398 page_frag_free(c->r2t_pdu);
1399 page_frag_free(c->data_pdu);
1400 page_frag_free(c->rsp_pdu);
1401 page_frag_free(c->cmd_pdu);
1404 static int nvmet_tcp_alloc_cmds(struct nvmet_tcp_queue *queue)
1406 struct nvmet_tcp_cmd *cmds;
1407 int i, ret = -EINVAL, nr_cmds = queue->nr_cmds;
1409 cmds = kcalloc(nr_cmds, sizeof(struct nvmet_tcp_cmd), GFP_KERNEL);
1413 for (i = 0; i < nr_cmds; i++) {
1414 ret = nvmet_tcp_alloc_cmd(queue, cmds + i);
1424 nvmet_tcp_free_cmd(cmds + i);
1430 static void nvmet_tcp_free_cmds(struct nvmet_tcp_queue *queue)
1432 struct nvmet_tcp_cmd *cmds = queue->cmds;
1435 for (i = 0; i < queue->nr_cmds; i++)
1436 nvmet_tcp_free_cmd(cmds + i);
1438 nvmet_tcp_free_cmd(&queue->connect);
1442 static void nvmet_tcp_restore_socket_callbacks(struct nvmet_tcp_queue *queue)
1444 struct socket *sock = queue->sock;
1446 write_lock_bh(&sock->sk->sk_callback_lock);
1447 sock->sk->sk_data_ready = queue->data_ready;
1448 sock->sk->sk_state_change = queue->state_change;
1449 sock->sk->sk_write_space = queue->write_space;
1450 sock->sk->sk_user_data = NULL;
1451 write_unlock_bh(&sock->sk->sk_callback_lock);
1454 static void nvmet_tcp_uninit_data_in_cmds(struct nvmet_tcp_queue *queue)
1456 struct nvmet_tcp_cmd *cmd = queue->cmds;
1459 for (i = 0; i < queue->nr_cmds; i++, cmd++) {
1460 if (nvmet_tcp_need_data_in(cmd))
1461 nvmet_req_uninit(&cmd->req);
1464 if (!queue->nr_cmds && nvmet_tcp_need_data_in(&queue->connect)) {
1465 /* failed in connect */
1466 nvmet_req_uninit(&queue->connect.req);
1470 static void nvmet_tcp_free_cmd_data_in_buffers(struct nvmet_tcp_queue *queue)
1472 struct nvmet_tcp_cmd *cmd = queue->cmds;
1475 for (i = 0; i < queue->nr_cmds; i++, cmd++) {
1476 if (nvmet_tcp_need_data_in(cmd))
1477 nvmet_tcp_free_cmd_buffers(cmd);
1480 if (!queue->nr_cmds && nvmet_tcp_need_data_in(&queue->connect))
1481 nvmet_tcp_free_cmd_buffers(&queue->connect);
1484 static void nvmet_tcp_release_queue_work(struct work_struct *w)
1487 struct nvmet_tcp_queue *queue =
1488 container_of(w, struct nvmet_tcp_queue, release_work);
1490 mutex_lock(&nvmet_tcp_queue_mutex);
1491 list_del_init(&queue->queue_list);
1492 mutex_unlock(&nvmet_tcp_queue_mutex);
1494 nvmet_tcp_restore_socket_callbacks(queue);
1495 cancel_work_sync(&queue->io_work);
1496 /* stop accepting incoming data */
1497 queue->rcv_state = NVMET_TCP_RECV_ERR;
1499 nvmet_tcp_uninit_data_in_cmds(queue);
1500 nvmet_sq_destroy(&queue->nvme_sq);
1501 cancel_work_sync(&queue->io_work);
1502 nvmet_tcp_free_cmd_data_in_buffers(queue);
1503 sock_release(queue->sock);
1504 nvmet_tcp_free_cmds(queue);
1505 if (queue->hdr_digest || queue->data_digest)
1506 nvmet_tcp_free_crypto(queue);
1507 ida_free(&nvmet_tcp_queue_ida, queue->idx);
1509 page = virt_to_head_page(queue->pf_cache.va);
1510 __page_frag_cache_drain(page, queue->pf_cache.pagecnt_bias);
1514 static void nvmet_tcp_data_ready(struct sock *sk)
1516 struct nvmet_tcp_queue *queue;
1518 trace_sk_data_ready(sk);
1520 read_lock_bh(&sk->sk_callback_lock);
1521 queue = sk->sk_user_data;
1523 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &queue->io_work);
1524 read_unlock_bh(&sk->sk_callback_lock);
1527 static void nvmet_tcp_write_space(struct sock *sk)
1529 struct nvmet_tcp_queue *queue;
1531 read_lock_bh(&sk->sk_callback_lock);
1532 queue = sk->sk_user_data;
1533 if (unlikely(!queue))
1536 if (unlikely(queue->state == NVMET_TCP_Q_CONNECTING)) {
1537 queue->write_space(sk);
1541 if (sk_stream_is_writeable(sk)) {
1542 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1543 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &queue->io_work);
1546 read_unlock_bh(&sk->sk_callback_lock);
1549 static void nvmet_tcp_state_change(struct sock *sk)
1551 struct nvmet_tcp_queue *queue;
1553 read_lock_bh(&sk->sk_callback_lock);
1554 queue = sk->sk_user_data;
1558 switch (sk->sk_state) {
1563 case TCP_CLOSE_WAIT:
1566 nvmet_tcp_schedule_release_queue(queue);
1569 pr_warn("queue %d unhandled state %d\n",
1570 queue->idx, sk->sk_state);
1573 read_unlock_bh(&sk->sk_callback_lock);
1576 static int nvmet_tcp_set_queue_sock(struct nvmet_tcp_queue *queue)
1578 struct socket *sock = queue->sock;
1579 struct inet_sock *inet = inet_sk(sock->sk);
1582 ret = kernel_getsockname(sock,
1583 (struct sockaddr *)&queue->sockaddr);
1587 ret = kernel_getpeername(sock,
1588 (struct sockaddr *)&queue->sockaddr_peer);
1593 * Cleanup whatever is sitting in the TCP transmit queue on socket
1594 * close. This is done to prevent stale data from being sent should
1595 * the network connection be restored before TCP times out.
1597 sock_no_linger(sock->sk);
1599 if (so_priority > 0)
1600 sock_set_priority(sock->sk, so_priority);
1602 /* Set socket type of service */
1603 if (inet->rcv_tos > 0)
1604 ip_sock_set_tos(sock->sk, inet->rcv_tos);
1607 write_lock_bh(&sock->sk->sk_callback_lock);
1608 if (sock->sk->sk_state != TCP_ESTABLISHED) {
1610 * If the socket is already closing, don't even start
1615 sock->sk->sk_user_data = queue;
1616 queue->data_ready = sock->sk->sk_data_ready;
1617 sock->sk->sk_data_ready = nvmet_tcp_data_ready;
1618 queue->state_change = sock->sk->sk_state_change;
1619 sock->sk->sk_state_change = nvmet_tcp_state_change;
1620 queue->write_space = sock->sk->sk_write_space;
1621 sock->sk->sk_write_space = nvmet_tcp_write_space;
1622 if (idle_poll_period_usecs)
1623 nvmet_tcp_arm_queue_deadline(queue);
1624 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &queue->io_work);
1626 write_unlock_bh(&sock->sk->sk_callback_lock);
1631 static int nvmet_tcp_alloc_queue(struct nvmet_tcp_port *port,
1632 struct socket *newsock)
1634 struct nvmet_tcp_queue *queue;
1637 queue = kzalloc(sizeof(*queue), GFP_KERNEL);
1641 INIT_WORK(&queue->release_work, nvmet_tcp_release_queue_work);
1642 INIT_WORK(&queue->io_work, nvmet_tcp_io_work);
1643 queue->sock = newsock;
1646 spin_lock_init(&queue->state_lock);
1647 queue->state = NVMET_TCP_Q_CONNECTING;
1648 INIT_LIST_HEAD(&queue->free_list);
1649 init_llist_head(&queue->resp_list);
1650 INIT_LIST_HEAD(&queue->resp_send_list);
1652 queue->idx = ida_alloc(&nvmet_tcp_queue_ida, GFP_KERNEL);
1653 if (queue->idx < 0) {
1655 goto out_free_queue;
1658 ret = nvmet_tcp_alloc_cmd(queue, &queue->connect);
1660 goto out_ida_remove;
1662 ret = nvmet_sq_init(&queue->nvme_sq);
1664 goto out_free_connect;
1666 nvmet_prepare_receive_pdu(queue);
1668 mutex_lock(&nvmet_tcp_queue_mutex);
1669 list_add_tail(&queue->queue_list, &nvmet_tcp_queue_list);
1670 mutex_unlock(&nvmet_tcp_queue_mutex);
1672 ret = nvmet_tcp_set_queue_sock(queue);
1674 goto out_destroy_sq;
1678 mutex_lock(&nvmet_tcp_queue_mutex);
1679 list_del_init(&queue->queue_list);
1680 mutex_unlock(&nvmet_tcp_queue_mutex);
1681 nvmet_sq_destroy(&queue->nvme_sq);
1683 nvmet_tcp_free_cmd(&queue->connect);
1685 ida_free(&nvmet_tcp_queue_ida, queue->idx);
1691 static void nvmet_tcp_accept_work(struct work_struct *w)
1693 struct nvmet_tcp_port *port =
1694 container_of(w, struct nvmet_tcp_port, accept_work);
1695 struct socket *newsock;
1699 ret = kernel_accept(port->sock, &newsock, O_NONBLOCK);
1702 pr_warn("failed to accept err=%d\n", ret);
1705 ret = nvmet_tcp_alloc_queue(port, newsock);
1707 pr_err("failed to allocate queue\n");
1708 sock_release(newsock);
1713 static void nvmet_tcp_listen_data_ready(struct sock *sk)
1715 struct nvmet_tcp_port *port;
1717 trace_sk_data_ready(sk);
1719 read_lock_bh(&sk->sk_callback_lock);
1720 port = sk->sk_user_data;
1724 if (sk->sk_state == TCP_LISTEN)
1725 queue_work(nvmet_wq, &port->accept_work);
1727 read_unlock_bh(&sk->sk_callback_lock);
1730 static int nvmet_tcp_add_port(struct nvmet_port *nport)
1732 struct nvmet_tcp_port *port;
1733 __kernel_sa_family_t af;
1736 port = kzalloc(sizeof(*port), GFP_KERNEL);
1740 switch (nport->disc_addr.adrfam) {
1741 case NVMF_ADDR_FAMILY_IP4:
1744 case NVMF_ADDR_FAMILY_IP6:
1748 pr_err("address family %d not supported\n",
1749 nport->disc_addr.adrfam);
1754 ret = inet_pton_with_scope(&init_net, af, nport->disc_addr.traddr,
1755 nport->disc_addr.trsvcid, &port->addr);
1757 pr_err("malformed ip/port passed: %s:%s\n",
1758 nport->disc_addr.traddr, nport->disc_addr.trsvcid);
1762 port->nport = nport;
1763 INIT_WORK(&port->accept_work, nvmet_tcp_accept_work);
1764 if (port->nport->inline_data_size < 0)
1765 port->nport->inline_data_size = NVMET_TCP_DEF_INLINE_DATA_SIZE;
1767 ret = sock_create(port->addr.ss_family, SOCK_STREAM,
1768 IPPROTO_TCP, &port->sock);
1770 pr_err("failed to create a socket\n");
1774 port->sock->sk->sk_user_data = port;
1775 port->data_ready = port->sock->sk->sk_data_ready;
1776 port->sock->sk->sk_data_ready = nvmet_tcp_listen_data_ready;
1777 sock_set_reuseaddr(port->sock->sk);
1778 tcp_sock_set_nodelay(port->sock->sk);
1779 if (so_priority > 0)
1780 sock_set_priority(port->sock->sk, so_priority);
1782 ret = kernel_bind(port->sock, (struct sockaddr *)&port->addr,
1783 sizeof(port->addr));
1785 pr_err("failed to bind port socket %d\n", ret);
1789 ret = kernel_listen(port->sock, 128);
1791 pr_err("failed to listen %d on port sock\n", ret);
1796 pr_info("enabling port %d (%pISpc)\n",
1797 le16_to_cpu(nport->disc_addr.portid), &port->addr);
1802 sock_release(port->sock);
1808 static void nvmet_tcp_destroy_port_queues(struct nvmet_tcp_port *port)
1810 struct nvmet_tcp_queue *queue;
1812 mutex_lock(&nvmet_tcp_queue_mutex);
1813 list_for_each_entry(queue, &nvmet_tcp_queue_list, queue_list)
1814 if (queue->port == port)
1815 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
1816 mutex_unlock(&nvmet_tcp_queue_mutex);
1819 static void nvmet_tcp_remove_port(struct nvmet_port *nport)
1821 struct nvmet_tcp_port *port = nport->priv;
1823 write_lock_bh(&port->sock->sk->sk_callback_lock);
1824 port->sock->sk->sk_data_ready = port->data_ready;
1825 port->sock->sk->sk_user_data = NULL;
1826 write_unlock_bh(&port->sock->sk->sk_callback_lock);
1827 cancel_work_sync(&port->accept_work);
1829 * Destroy the remaining queues, which are not belong to any
1832 nvmet_tcp_destroy_port_queues(port);
1834 sock_release(port->sock);
1838 static void nvmet_tcp_delete_ctrl(struct nvmet_ctrl *ctrl)
1840 struct nvmet_tcp_queue *queue;
1842 mutex_lock(&nvmet_tcp_queue_mutex);
1843 list_for_each_entry(queue, &nvmet_tcp_queue_list, queue_list)
1844 if (queue->nvme_sq.ctrl == ctrl)
1845 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
1846 mutex_unlock(&nvmet_tcp_queue_mutex);
1849 static u16 nvmet_tcp_install_queue(struct nvmet_sq *sq)
1851 struct nvmet_tcp_queue *queue =
1852 container_of(sq, struct nvmet_tcp_queue, nvme_sq);
1855 /* Let inflight controller teardown complete */
1856 flush_workqueue(nvmet_wq);
1859 queue->nr_cmds = sq->size * 2;
1860 if (nvmet_tcp_alloc_cmds(queue))
1861 return NVME_SC_INTERNAL;
1865 static void nvmet_tcp_disc_port_addr(struct nvmet_req *req,
1866 struct nvmet_port *nport, char *traddr)
1868 struct nvmet_tcp_port *port = nport->priv;
1870 if (inet_addr_is_any((struct sockaddr *)&port->addr)) {
1871 struct nvmet_tcp_cmd *cmd =
1872 container_of(req, struct nvmet_tcp_cmd, req);
1873 struct nvmet_tcp_queue *queue = cmd->queue;
1875 sprintf(traddr, "%pISc", (struct sockaddr *)&queue->sockaddr);
1877 memcpy(traddr, nport->disc_addr.traddr, NVMF_TRADDR_SIZE);
1881 static const struct nvmet_fabrics_ops nvmet_tcp_ops = {
1882 .owner = THIS_MODULE,
1883 .type = NVMF_TRTYPE_TCP,
1885 .add_port = nvmet_tcp_add_port,
1886 .remove_port = nvmet_tcp_remove_port,
1887 .queue_response = nvmet_tcp_queue_response,
1888 .delete_ctrl = nvmet_tcp_delete_ctrl,
1889 .install_queue = nvmet_tcp_install_queue,
1890 .disc_traddr = nvmet_tcp_disc_port_addr,
1893 static int __init nvmet_tcp_init(void)
1897 nvmet_tcp_wq = alloc_workqueue("nvmet_tcp_wq",
1898 WQ_MEM_RECLAIM | WQ_HIGHPRI, 0);
1902 ret = nvmet_register_transport(&nvmet_tcp_ops);
1908 destroy_workqueue(nvmet_tcp_wq);
1912 static void __exit nvmet_tcp_exit(void)
1914 struct nvmet_tcp_queue *queue;
1916 nvmet_unregister_transport(&nvmet_tcp_ops);
1918 flush_workqueue(nvmet_wq);
1919 mutex_lock(&nvmet_tcp_queue_mutex);
1920 list_for_each_entry(queue, &nvmet_tcp_queue_list, queue_list)
1921 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
1922 mutex_unlock(&nvmet_tcp_queue_mutex);
1923 flush_workqueue(nvmet_wq);
1925 destroy_workqueue(nvmet_tcp_wq);
1928 module_init(nvmet_tcp_init);
1929 module_exit(nvmet_tcp_exit);
1931 MODULE_LICENSE("GPL v2");
1932 MODULE_ALIAS("nvmet-transport-3"); /* 3 == NVMF_TRTYPE_TCP */