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>
20 #define NVMET_TCP_DEF_INLINE_DATA_SIZE (4 * PAGE_SIZE)
22 /* Define the socket priority to use for connections were it is desirable
23 * that the NIC consider performing optimized packet processing or filtering.
24 * A non-zero value being sufficient to indicate general consideration of any
25 * possible optimization. Making it a module param allows for alternative
26 * values that may be unique for some NIC implementations.
28 static int so_priority;
29 module_param(so_priority, int, 0644);
30 MODULE_PARM_DESC(so_priority, "nvmet tcp socket optimize priority");
32 /* Define a time period (in usecs) that io_work() shall sample an activated
33 * queue before determining it to be idle. This optional module behavior
34 * can enable NIC solutions that support socket optimized packet processing
35 * using advanced interrupt moderation techniques.
37 static int idle_poll_period_usecs;
38 module_param(idle_poll_period_usecs, int, 0644);
39 MODULE_PARM_DESC(idle_poll_period_usecs,
40 "nvmet tcp io_work poll till idle time period in usecs");
42 #define NVMET_TCP_RECV_BUDGET 8
43 #define NVMET_TCP_SEND_BUDGET 8
44 #define NVMET_TCP_IO_WORK_BUDGET 64
46 enum nvmet_tcp_send_state {
47 NVMET_TCP_SEND_DATA_PDU,
51 NVMET_TCP_SEND_RESPONSE
54 enum nvmet_tcp_recv_state {
62 NVMET_TCP_F_INIT_FAILED = (1 << 0),
65 struct nvmet_tcp_cmd {
66 struct nvmet_tcp_queue *queue;
69 struct nvme_tcp_cmd_pdu *cmd_pdu;
70 struct nvme_tcp_rsp_pdu *rsp_pdu;
71 struct nvme_tcp_data_pdu *data_pdu;
72 struct nvme_tcp_r2t_pdu *r2t_pdu;
81 struct msghdr recv_msg;
85 struct list_head entry;
86 struct llist_node lentry;
90 struct scatterlist *cur_sg;
91 enum nvmet_tcp_send_state state;
97 enum nvmet_tcp_queue_state {
98 NVMET_TCP_Q_CONNECTING,
100 NVMET_TCP_Q_DISCONNECTING,
103 struct nvmet_tcp_queue {
105 struct nvmet_tcp_port *port;
106 struct work_struct io_work;
107 struct nvmet_cq nvme_cq;
108 struct nvmet_sq nvme_sq;
111 struct nvmet_tcp_cmd *cmds;
112 unsigned int nr_cmds;
113 struct list_head free_list;
114 struct llist_head resp_list;
115 struct list_head resp_send_list;
117 struct nvmet_tcp_cmd *snd_cmd;
122 enum nvmet_tcp_recv_state rcv_state;
123 struct nvmet_tcp_cmd *cmd;
124 union nvme_tcp_pdu pdu;
129 struct ahash_request *snd_hash;
130 struct ahash_request *rcv_hash;
132 unsigned long poll_end;
134 spinlock_t state_lock;
135 enum nvmet_tcp_queue_state state;
137 struct sockaddr_storage sockaddr;
138 struct sockaddr_storage sockaddr_peer;
139 struct work_struct release_work;
142 struct list_head queue_list;
144 struct nvmet_tcp_cmd connect;
146 struct page_frag_cache pf_cache;
148 void (*data_ready)(struct sock *);
149 void (*state_change)(struct sock *);
150 void (*write_space)(struct sock *);
153 struct nvmet_tcp_port {
155 struct work_struct accept_work;
156 struct nvmet_port *nport;
157 struct sockaddr_storage addr;
158 void (*data_ready)(struct sock *);
161 static DEFINE_IDA(nvmet_tcp_queue_ida);
162 static LIST_HEAD(nvmet_tcp_queue_list);
163 static DEFINE_MUTEX(nvmet_tcp_queue_mutex);
165 static struct workqueue_struct *nvmet_tcp_wq;
166 static const struct nvmet_fabrics_ops nvmet_tcp_ops;
167 static void nvmet_tcp_free_cmd(struct nvmet_tcp_cmd *c);
168 static void nvmet_tcp_finish_cmd(struct nvmet_tcp_cmd *cmd);
169 static void nvmet_tcp_free_cmd_buffers(struct nvmet_tcp_cmd *cmd);
170 static void nvmet_tcp_unmap_pdu_iovec(struct nvmet_tcp_cmd *cmd);
172 static inline u16 nvmet_tcp_cmd_tag(struct nvmet_tcp_queue *queue,
173 struct nvmet_tcp_cmd *cmd)
175 if (unlikely(!queue->nr_cmds)) {
176 /* We didn't allocate cmds yet, send 0xffff */
180 return cmd - queue->cmds;
183 static inline bool nvmet_tcp_has_data_in(struct nvmet_tcp_cmd *cmd)
185 return nvme_is_write(cmd->req.cmd) &&
186 cmd->rbytes_done < cmd->req.transfer_len;
189 static inline bool nvmet_tcp_need_data_in(struct nvmet_tcp_cmd *cmd)
191 return nvmet_tcp_has_data_in(cmd) && !cmd->req.cqe->status;
194 static inline bool nvmet_tcp_need_data_out(struct nvmet_tcp_cmd *cmd)
196 return !nvme_is_write(cmd->req.cmd) &&
197 cmd->req.transfer_len > 0 &&
198 !cmd->req.cqe->status;
201 static inline bool nvmet_tcp_has_inline_data(struct nvmet_tcp_cmd *cmd)
203 return nvme_is_write(cmd->req.cmd) && cmd->pdu_len &&
207 static inline struct nvmet_tcp_cmd *
208 nvmet_tcp_get_cmd(struct nvmet_tcp_queue *queue)
210 struct nvmet_tcp_cmd *cmd;
212 cmd = list_first_entry_or_null(&queue->free_list,
213 struct nvmet_tcp_cmd, entry);
216 list_del_init(&cmd->entry);
218 cmd->rbytes_done = cmd->wbytes_done = 0;
226 static inline void nvmet_tcp_put_cmd(struct nvmet_tcp_cmd *cmd)
228 if (unlikely(cmd == &cmd->queue->connect))
231 list_add_tail(&cmd->entry, &cmd->queue->free_list);
234 static inline int queue_cpu(struct nvmet_tcp_queue *queue)
236 return queue->sock->sk->sk_incoming_cpu;
239 static inline u8 nvmet_tcp_hdgst_len(struct nvmet_tcp_queue *queue)
241 return queue->hdr_digest ? NVME_TCP_DIGEST_LENGTH : 0;
244 static inline u8 nvmet_tcp_ddgst_len(struct nvmet_tcp_queue *queue)
246 return queue->data_digest ? NVME_TCP_DIGEST_LENGTH : 0;
249 static inline void nvmet_tcp_hdgst(struct ahash_request *hash,
250 void *pdu, size_t len)
252 struct scatterlist sg;
254 sg_init_one(&sg, pdu, len);
255 ahash_request_set_crypt(hash, &sg, pdu + len, len);
256 crypto_ahash_digest(hash);
259 static int nvmet_tcp_verify_hdgst(struct nvmet_tcp_queue *queue,
260 void *pdu, size_t len)
262 struct nvme_tcp_hdr *hdr = pdu;
266 if (unlikely(!(hdr->flags & NVME_TCP_F_HDGST))) {
267 pr_err("queue %d: header digest enabled but no header digest\n",
272 recv_digest = *(__le32 *)(pdu + hdr->hlen);
273 nvmet_tcp_hdgst(queue->rcv_hash, pdu, len);
274 exp_digest = *(__le32 *)(pdu + hdr->hlen);
275 if (recv_digest != exp_digest) {
276 pr_err("queue %d: header digest error: recv %#x expected %#x\n",
277 queue->idx, le32_to_cpu(recv_digest),
278 le32_to_cpu(exp_digest));
285 static int nvmet_tcp_check_ddgst(struct nvmet_tcp_queue *queue, void *pdu)
287 struct nvme_tcp_hdr *hdr = pdu;
288 u8 digest_len = nvmet_tcp_hdgst_len(queue);
291 len = le32_to_cpu(hdr->plen) - hdr->hlen -
292 (hdr->flags & NVME_TCP_F_HDGST ? digest_len : 0);
294 if (unlikely(len && !(hdr->flags & NVME_TCP_F_DDGST))) {
295 pr_err("queue %d: data digest flag is cleared\n", queue->idx);
302 static void nvmet_tcp_free_cmd_buffers(struct nvmet_tcp_cmd *cmd)
304 WARN_ON(unlikely(cmd->nr_mapped > 0));
307 sgl_free(cmd->req.sg);
312 static void nvmet_tcp_unmap_pdu_iovec(struct nvmet_tcp_cmd *cmd)
314 struct scatterlist *sg;
317 sg = &cmd->req.sg[cmd->sg_idx];
319 for (i = 0; i < cmd->nr_mapped; i++)
320 kunmap(sg_page(&sg[i]));
325 static void nvmet_tcp_map_pdu_iovec(struct nvmet_tcp_cmd *cmd)
327 struct kvec *iov = cmd->iov;
328 struct scatterlist *sg;
329 u32 length, offset, sg_offset;
331 length = cmd->pdu_len;
332 cmd->nr_mapped = DIV_ROUND_UP(length, PAGE_SIZE);
333 offset = cmd->rbytes_done;
334 cmd->sg_idx = offset / PAGE_SIZE;
335 sg_offset = offset % PAGE_SIZE;
336 sg = &cmd->req.sg[cmd->sg_idx];
339 u32 iov_len = min_t(u32, length, sg->length - sg_offset);
341 iov->iov_base = kmap(sg_page(sg)) + sg->offset + sg_offset;
342 iov->iov_len = iov_len;
350 iov_iter_kvec(&cmd->recv_msg.msg_iter, READ, cmd->iov,
351 cmd->nr_mapped, cmd->pdu_len);
354 static void nvmet_tcp_fatal_error(struct nvmet_tcp_queue *queue)
356 queue->rcv_state = NVMET_TCP_RECV_ERR;
357 if (queue->nvme_sq.ctrl)
358 nvmet_ctrl_fatal_error(queue->nvme_sq.ctrl);
360 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
363 static void nvmet_tcp_socket_error(struct nvmet_tcp_queue *queue, int status)
365 if (status == -EPIPE || status == -ECONNRESET)
366 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
368 nvmet_tcp_fatal_error(queue);
371 static int nvmet_tcp_map_data(struct nvmet_tcp_cmd *cmd)
373 struct nvme_sgl_desc *sgl = &cmd->req.cmd->common.dptr.sgl;
374 u32 len = le32_to_cpu(sgl->length);
379 if (sgl->type == ((NVME_SGL_FMT_DATA_DESC << 4) |
380 NVME_SGL_FMT_OFFSET)) {
381 if (!nvme_is_write(cmd->req.cmd))
382 return NVME_SC_INVALID_FIELD | NVME_SC_DNR;
384 if (len > cmd->req.port->inline_data_size)
385 return NVME_SC_SGL_INVALID_OFFSET | NVME_SC_DNR;
388 cmd->req.transfer_len += len;
390 cmd->req.sg = sgl_alloc(len, GFP_KERNEL, &cmd->req.sg_cnt);
392 return NVME_SC_INTERNAL;
393 cmd->cur_sg = cmd->req.sg;
395 if (nvmet_tcp_has_data_in(cmd)) {
396 cmd->iov = kmalloc_array(cmd->req.sg_cnt,
397 sizeof(*cmd->iov), GFP_KERNEL);
404 nvmet_tcp_free_cmd_buffers(cmd);
405 return NVME_SC_INTERNAL;
408 static void nvmet_tcp_send_ddgst(struct ahash_request *hash,
409 struct nvmet_tcp_cmd *cmd)
411 ahash_request_set_crypt(hash, cmd->req.sg,
412 (void *)&cmd->exp_ddgst, cmd->req.transfer_len);
413 crypto_ahash_digest(hash);
416 static void nvmet_tcp_recv_ddgst(struct ahash_request *hash,
417 struct nvmet_tcp_cmd *cmd)
419 struct scatterlist sg;
423 crypto_ahash_init(hash);
424 for (i = 0, iov = cmd->iov; i < cmd->nr_mapped; i++, iov++) {
425 sg_init_one(&sg, iov->iov_base, iov->iov_len);
426 ahash_request_set_crypt(hash, &sg, NULL, iov->iov_len);
427 crypto_ahash_update(hash);
429 ahash_request_set_crypt(hash, NULL, (void *)&cmd->exp_ddgst, 0);
430 crypto_ahash_final(hash);
433 static void nvmet_setup_c2h_data_pdu(struct nvmet_tcp_cmd *cmd)
435 struct nvme_tcp_data_pdu *pdu = cmd->data_pdu;
436 struct nvmet_tcp_queue *queue = cmd->queue;
437 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
438 u8 ddgst = nvmet_tcp_ddgst_len(cmd->queue);
441 cmd->state = NVMET_TCP_SEND_DATA_PDU;
443 pdu->hdr.type = nvme_tcp_c2h_data;
444 pdu->hdr.flags = NVME_TCP_F_DATA_LAST | (queue->nvme_sq.sqhd_disabled ?
445 NVME_TCP_F_DATA_SUCCESS : 0);
446 pdu->hdr.hlen = sizeof(*pdu);
447 pdu->hdr.pdo = pdu->hdr.hlen + hdgst;
449 cpu_to_le32(pdu->hdr.hlen + hdgst +
450 cmd->req.transfer_len + ddgst);
451 pdu->command_id = cmd->req.cqe->command_id;
452 pdu->data_length = cpu_to_le32(cmd->req.transfer_len);
453 pdu->data_offset = cpu_to_le32(cmd->wbytes_done);
455 if (queue->data_digest) {
456 pdu->hdr.flags |= NVME_TCP_F_DDGST;
457 nvmet_tcp_send_ddgst(queue->snd_hash, cmd);
460 if (cmd->queue->hdr_digest) {
461 pdu->hdr.flags |= NVME_TCP_F_HDGST;
462 nvmet_tcp_hdgst(queue->snd_hash, pdu, sizeof(*pdu));
466 static void nvmet_setup_r2t_pdu(struct nvmet_tcp_cmd *cmd)
468 struct nvme_tcp_r2t_pdu *pdu = cmd->r2t_pdu;
469 struct nvmet_tcp_queue *queue = cmd->queue;
470 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
473 cmd->state = NVMET_TCP_SEND_R2T;
475 pdu->hdr.type = nvme_tcp_r2t;
477 pdu->hdr.hlen = sizeof(*pdu);
479 pdu->hdr.plen = cpu_to_le32(pdu->hdr.hlen + hdgst);
481 pdu->command_id = cmd->req.cmd->common.command_id;
482 pdu->ttag = nvmet_tcp_cmd_tag(cmd->queue, cmd);
483 pdu->r2t_length = cpu_to_le32(cmd->req.transfer_len - cmd->rbytes_done);
484 pdu->r2t_offset = cpu_to_le32(cmd->rbytes_done);
485 if (cmd->queue->hdr_digest) {
486 pdu->hdr.flags |= NVME_TCP_F_HDGST;
487 nvmet_tcp_hdgst(queue->snd_hash, pdu, sizeof(*pdu));
491 static void nvmet_setup_response_pdu(struct nvmet_tcp_cmd *cmd)
493 struct nvme_tcp_rsp_pdu *pdu = cmd->rsp_pdu;
494 struct nvmet_tcp_queue *queue = cmd->queue;
495 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
498 cmd->state = NVMET_TCP_SEND_RESPONSE;
500 pdu->hdr.type = nvme_tcp_rsp;
502 pdu->hdr.hlen = sizeof(*pdu);
504 pdu->hdr.plen = cpu_to_le32(pdu->hdr.hlen + hdgst);
505 if (cmd->queue->hdr_digest) {
506 pdu->hdr.flags |= NVME_TCP_F_HDGST;
507 nvmet_tcp_hdgst(queue->snd_hash, pdu, sizeof(*pdu));
511 static void nvmet_tcp_process_resp_list(struct nvmet_tcp_queue *queue)
513 struct llist_node *node;
514 struct nvmet_tcp_cmd *cmd;
516 for (node = llist_del_all(&queue->resp_list); node; node = node->next) {
517 cmd = llist_entry(node, struct nvmet_tcp_cmd, lentry);
518 list_add(&cmd->entry, &queue->resp_send_list);
519 queue->send_list_len++;
523 static struct nvmet_tcp_cmd *nvmet_tcp_fetch_cmd(struct nvmet_tcp_queue *queue)
525 queue->snd_cmd = list_first_entry_or_null(&queue->resp_send_list,
526 struct nvmet_tcp_cmd, entry);
527 if (!queue->snd_cmd) {
528 nvmet_tcp_process_resp_list(queue);
530 list_first_entry_or_null(&queue->resp_send_list,
531 struct nvmet_tcp_cmd, entry);
532 if (unlikely(!queue->snd_cmd))
536 list_del_init(&queue->snd_cmd->entry);
537 queue->send_list_len--;
539 if (nvmet_tcp_need_data_out(queue->snd_cmd))
540 nvmet_setup_c2h_data_pdu(queue->snd_cmd);
541 else if (nvmet_tcp_need_data_in(queue->snd_cmd))
542 nvmet_setup_r2t_pdu(queue->snd_cmd);
544 nvmet_setup_response_pdu(queue->snd_cmd);
546 return queue->snd_cmd;
549 static void nvmet_tcp_queue_response(struct nvmet_req *req)
551 struct nvmet_tcp_cmd *cmd =
552 container_of(req, struct nvmet_tcp_cmd, req);
553 struct nvmet_tcp_queue *queue = cmd->queue;
554 struct nvme_sgl_desc *sgl;
557 if (unlikely(cmd == queue->cmd)) {
558 sgl = &cmd->req.cmd->common.dptr.sgl;
559 len = le32_to_cpu(sgl->length);
562 * Wait for inline data before processing the response.
563 * Avoid using helpers, this might happen before
564 * nvmet_req_init is completed.
566 if (queue->rcv_state == NVMET_TCP_RECV_PDU &&
567 len && len <= cmd->req.port->inline_data_size &&
568 nvme_is_write(cmd->req.cmd))
572 llist_add(&cmd->lentry, &queue->resp_list);
573 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &cmd->queue->io_work);
576 static void nvmet_tcp_execute_request(struct nvmet_tcp_cmd *cmd)
578 if (unlikely(cmd->flags & NVMET_TCP_F_INIT_FAILED))
579 nvmet_tcp_queue_response(&cmd->req);
581 cmd->req.execute(&cmd->req);
584 static int nvmet_try_send_data_pdu(struct nvmet_tcp_cmd *cmd)
586 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
587 int left = sizeof(*cmd->data_pdu) - cmd->offset + hdgst;
590 ret = kernel_sendpage(cmd->queue->sock, virt_to_page(cmd->data_pdu),
591 offset_in_page(cmd->data_pdu) + cmd->offset,
592 left, MSG_DONTWAIT | MSG_MORE | MSG_SENDPAGE_NOTLAST);
602 cmd->state = NVMET_TCP_SEND_DATA;
607 static int nvmet_try_send_data(struct nvmet_tcp_cmd *cmd, bool last_in_batch)
609 struct nvmet_tcp_queue *queue = cmd->queue;
612 while (cmd->cur_sg) {
613 struct page *page = sg_page(cmd->cur_sg);
614 u32 left = cmd->cur_sg->length - cmd->offset;
615 int flags = MSG_DONTWAIT;
617 if ((!last_in_batch && cmd->queue->send_list_len) ||
618 cmd->wbytes_done + left < cmd->req.transfer_len ||
619 queue->data_digest || !queue->nvme_sq.sqhd_disabled)
620 flags |= MSG_MORE | MSG_SENDPAGE_NOTLAST;
622 ret = kernel_sendpage(cmd->queue->sock, page, cmd->offset,
628 cmd->wbytes_done += ret;
631 if (cmd->offset == cmd->cur_sg->length) {
632 cmd->cur_sg = sg_next(cmd->cur_sg);
637 if (queue->data_digest) {
638 cmd->state = NVMET_TCP_SEND_DDGST;
641 if (queue->nvme_sq.sqhd_disabled) {
642 cmd->queue->snd_cmd = NULL;
643 nvmet_tcp_put_cmd(cmd);
645 nvmet_setup_response_pdu(cmd);
649 if (queue->nvme_sq.sqhd_disabled)
650 nvmet_tcp_free_cmd_buffers(cmd);
656 static int nvmet_try_send_response(struct nvmet_tcp_cmd *cmd,
659 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
660 int left = sizeof(*cmd->rsp_pdu) - cmd->offset + hdgst;
661 int flags = MSG_DONTWAIT;
664 if (!last_in_batch && cmd->queue->send_list_len)
665 flags |= MSG_MORE | MSG_SENDPAGE_NOTLAST;
669 ret = kernel_sendpage(cmd->queue->sock, virt_to_page(cmd->rsp_pdu),
670 offset_in_page(cmd->rsp_pdu) + cmd->offset, left, flags);
679 nvmet_tcp_free_cmd_buffers(cmd);
680 cmd->queue->snd_cmd = NULL;
681 nvmet_tcp_put_cmd(cmd);
685 static int nvmet_try_send_r2t(struct nvmet_tcp_cmd *cmd, bool last_in_batch)
687 u8 hdgst = nvmet_tcp_hdgst_len(cmd->queue);
688 int left = sizeof(*cmd->r2t_pdu) - cmd->offset + hdgst;
689 int flags = MSG_DONTWAIT;
692 if (!last_in_batch && cmd->queue->send_list_len)
693 flags |= MSG_MORE | MSG_SENDPAGE_NOTLAST;
697 ret = kernel_sendpage(cmd->queue->sock, virt_to_page(cmd->r2t_pdu),
698 offset_in_page(cmd->r2t_pdu) + cmd->offset, left, flags);
707 cmd->queue->snd_cmd = NULL;
711 static int nvmet_try_send_ddgst(struct nvmet_tcp_cmd *cmd, bool last_in_batch)
713 struct nvmet_tcp_queue *queue = cmd->queue;
714 int left = NVME_TCP_DIGEST_LENGTH - cmd->offset;
715 struct msghdr msg = { .msg_flags = MSG_DONTWAIT };
717 .iov_base = (u8 *)&cmd->exp_ddgst + cmd->offset,
722 if (!last_in_batch && cmd->queue->send_list_len)
723 msg.msg_flags |= MSG_MORE;
725 msg.msg_flags |= MSG_EOR;
727 ret = kernel_sendmsg(queue->sock, &msg, &iov, 1, iov.iov_len);
728 if (unlikely(ret <= 0))
737 if (queue->nvme_sq.sqhd_disabled) {
738 cmd->queue->snd_cmd = NULL;
739 nvmet_tcp_put_cmd(cmd);
741 nvmet_setup_response_pdu(cmd);
746 static int nvmet_tcp_try_send_one(struct nvmet_tcp_queue *queue,
749 struct nvmet_tcp_cmd *cmd = queue->snd_cmd;
752 if (!cmd || queue->state == NVMET_TCP_Q_DISCONNECTING) {
753 cmd = nvmet_tcp_fetch_cmd(queue);
758 if (cmd->state == NVMET_TCP_SEND_DATA_PDU) {
759 ret = nvmet_try_send_data_pdu(cmd);
764 if (cmd->state == NVMET_TCP_SEND_DATA) {
765 ret = nvmet_try_send_data(cmd, last_in_batch);
770 if (cmd->state == NVMET_TCP_SEND_DDGST) {
771 ret = nvmet_try_send_ddgst(cmd, last_in_batch);
776 if (cmd->state == NVMET_TCP_SEND_R2T) {
777 ret = nvmet_try_send_r2t(cmd, last_in_batch);
782 if (cmd->state == NVMET_TCP_SEND_RESPONSE)
783 ret = nvmet_try_send_response(cmd, last_in_batch);
795 static int nvmet_tcp_try_send(struct nvmet_tcp_queue *queue,
796 int budget, int *sends)
800 for (i = 0; i < budget; i++) {
801 ret = nvmet_tcp_try_send_one(queue, i == budget - 1);
802 if (unlikely(ret < 0)) {
803 nvmet_tcp_socket_error(queue, ret);
805 } else if (ret == 0) {
814 static void nvmet_prepare_receive_pdu(struct nvmet_tcp_queue *queue)
817 queue->left = sizeof(struct nvme_tcp_hdr);
819 queue->rcv_state = NVMET_TCP_RECV_PDU;
822 static void nvmet_tcp_free_crypto(struct nvmet_tcp_queue *queue)
824 struct crypto_ahash *tfm = crypto_ahash_reqtfm(queue->rcv_hash);
826 ahash_request_free(queue->rcv_hash);
827 ahash_request_free(queue->snd_hash);
828 crypto_free_ahash(tfm);
831 static int nvmet_tcp_alloc_crypto(struct nvmet_tcp_queue *queue)
833 struct crypto_ahash *tfm;
835 tfm = crypto_alloc_ahash("crc32c", 0, CRYPTO_ALG_ASYNC);
839 queue->snd_hash = ahash_request_alloc(tfm, GFP_KERNEL);
840 if (!queue->snd_hash)
842 ahash_request_set_callback(queue->snd_hash, 0, NULL, NULL);
844 queue->rcv_hash = ahash_request_alloc(tfm, GFP_KERNEL);
845 if (!queue->rcv_hash)
847 ahash_request_set_callback(queue->rcv_hash, 0, NULL, NULL);
851 ahash_request_free(queue->snd_hash);
853 crypto_free_ahash(tfm);
858 static int nvmet_tcp_handle_icreq(struct nvmet_tcp_queue *queue)
860 struct nvme_tcp_icreq_pdu *icreq = &queue->pdu.icreq;
861 struct nvme_tcp_icresp_pdu *icresp = &queue->pdu.icresp;
862 struct msghdr msg = {};
866 if (le32_to_cpu(icreq->hdr.plen) != sizeof(struct nvme_tcp_icreq_pdu)) {
867 pr_err("bad nvme-tcp pdu length (%d)\n",
868 le32_to_cpu(icreq->hdr.plen));
869 nvmet_tcp_fatal_error(queue);
872 if (icreq->pfv != NVME_TCP_PFV_1_0) {
873 pr_err("queue %d: bad pfv %d\n", queue->idx, icreq->pfv);
877 if (icreq->hpda != 0) {
878 pr_err("queue %d: unsupported hpda %d\n", queue->idx,
883 queue->hdr_digest = !!(icreq->digest & NVME_TCP_HDR_DIGEST_ENABLE);
884 queue->data_digest = !!(icreq->digest & NVME_TCP_DATA_DIGEST_ENABLE);
885 if (queue->hdr_digest || queue->data_digest) {
886 ret = nvmet_tcp_alloc_crypto(queue);
891 memset(icresp, 0, sizeof(*icresp));
892 icresp->hdr.type = nvme_tcp_icresp;
893 icresp->hdr.hlen = sizeof(*icresp);
895 icresp->hdr.plen = cpu_to_le32(icresp->hdr.hlen);
896 icresp->pfv = cpu_to_le16(NVME_TCP_PFV_1_0);
897 icresp->maxdata = cpu_to_le32(0x400000); /* 16M arbitrary limit */
899 if (queue->hdr_digest)
900 icresp->digest |= NVME_TCP_HDR_DIGEST_ENABLE;
901 if (queue->data_digest)
902 icresp->digest |= NVME_TCP_DATA_DIGEST_ENABLE;
904 iov.iov_base = icresp;
905 iov.iov_len = sizeof(*icresp);
906 ret = kernel_sendmsg(queue->sock, &msg, &iov, 1, iov.iov_len);
910 queue->state = NVMET_TCP_Q_LIVE;
911 nvmet_prepare_receive_pdu(queue);
914 if (queue->hdr_digest || queue->data_digest)
915 nvmet_tcp_free_crypto(queue);
919 static void nvmet_tcp_handle_req_failure(struct nvmet_tcp_queue *queue,
920 struct nvmet_tcp_cmd *cmd, struct nvmet_req *req)
922 size_t data_len = le32_to_cpu(req->cmd->common.dptr.sgl.length);
926 * This command has not been processed yet, hence we are trying to
927 * figure out if there is still pending data left to receive. If
928 * we don't, we can simply prepare for the next pdu and bail out,
929 * otherwise we will need to prepare a buffer and receive the
930 * stale data before continuing forward.
932 if (!nvme_is_write(cmd->req.cmd) || !data_len ||
933 data_len > cmd->req.port->inline_data_size) {
934 nvmet_prepare_receive_pdu(queue);
938 ret = nvmet_tcp_map_data(cmd);
940 pr_err("queue %d: failed to map data\n", queue->idx);
941 nvmet_tcp_fatal_error(queue);
945 queue->rcv_state = NVMET_TCP_RECV_DATA;
946 nvmet_tcp_map_pdu_iovec(cmd);
947 cmd->flags |= NVMET_TCP_F_INIT_FAILED;
950 static int nvmet_tcp_handle_h2c_data_pdu(struct nvmet_tcp_queue *queue)
952 struct nvme_tcp_data_pdu *data = &queue->pdu.data;
953 struct nvmet_tcp_cmd *cmd;
955 if (likely(queue->nr_cmds))
956 cmd = &queue->cmds[data->ttag];
958 cmd = &queue->connect;
960 if (le32_to_cpu(data->data_offset) != cmd->rbytes_done) {
961 pr_err("ttag %u unexpected data offset %u (expected %u)\n",
962 data->ttag, le32_to_cpu(data->data_offset),
964 /* FIXME: use path and transport errors */
965 nvmet_req_complete(&cmd->req,
966 NVME_SC_INVALID_FIELD | NVME_SC_DNR);
970 cmd->pdu_len = le32_to_cpu(data->data_length);
972 nvmet_tcp_map_pdu_iovec(cmd);
974 queue->rcv_state = NVMET_TCP_RECV_DATA;
979 static int nvmet_tcp_done_recv_pdu(struct nvmet_tcp_queue *queue)
981 struct nvme_tcp_hdr *hdr = &queue->pdu.cmd.hdr;
982 struct nvme_command *nvme_cmd = &queue->pdu.cmd.cmd;
983 struct nvmet_req *req;
986 if (unlikely(queue->state == NVMET_TCP_Q_CONNECTING)) {
987 if (hdr->type != nvme_tcp_icreq) {
988 pr_err("unexpected pdu type (%d) before icreq\n",
990 nvmet_tcp_fatal_error(queue);
993 return nvmet_tcp_handle_icreq(queue);
996 if (hdr->type == nvme_tcp_h2c_data) {
997 ret = nvmet_tcp_handle_h2c_data_pdu(queue);
1003 queue->cmd = nvmet_tcp_get_cmd(queue);
1004 if (unlikely(!queue->cmd)) {
1005 /* This should never happen */
1006 pr_err("queue %d: out of commands (%d) send_list_len: %d, opcode: %d",
1007 queue->idx, queue->nr_cmds, queue->send_list_len,
1008 nvme_cmd->common.opcode);
1009 nvmet_tcp_fatal_error(queue);
1013 req = &queue->cmd->req;
1014 memcpy(req->cmd, nvme_cmd, sizeof(*nvme_cmd));
1016 if (unlikely(!nvmet_req_init(req, &queue->nvme_cq,
1017 &queue->nvme_sq, &nvmet_tcp_ops))) {
1018 pr_err("failed cmd %p id %d opcode %d, data_len: %d\n",
1019 req->cmd, req->cmd->common.command_id,
1020 req->cmd->common.opcode,
1021 le32_to_cpu(req->cmd->common.dptr.sgl.length));
1023 nvmet_tcp_handle_req_failure(queue, queue->cmd, req);
1027 ret = nvmet_tcp_map_data(queue->cmd);
1028 if (unlikely(ret)) {
1029 pr_err("queue %d: failed to map data\n", queue->idx);
1030 if (nvmet_tcp_has_inline_data(queue->cmd))
1031 nvmet_tcp_fatal_error(queue);
1033 nvmet_req_complete(req, ret);
1038 if (nvmet_tcp_need_data_in(queue->cmd)) {
1039 if (nvmet_tcp_has_inline_data(queue->cmd)) {
1040 queue->rcv_state = NVMET_TCP_RECV_DATA;
1041 nvmet_tcp_map_pdu_iovec(queue->cmd);
1045 nvmet_tcp_queue_response(&queue->cmd->req);
1049 queue->cmd->req.execute(&queue->cmd->req);
1051 nvmet_prepare_receive_pdu(queue);
1055 static const u8 nvme_tcp_pdu_sizes[] = {
1056 [nvme_tcp_icreq] = sizeof(struct nvme_tcp_icreq_pdu),
1057 [nvme_tcp_cmd] = sizeof(struct nvme_tcp_cmd_pdu),
1058 [nvme_tcp_h2c_data] = sizeof(struct nvme_tcp_data_pdu),
1061 static inline u8 nvmet_tcp_pdu_size(u8 type)
1065 return (idx < ARRAY_SIZE(nvme_tcp_pdu_sizes) &&
1066 nvme_tcp_pdu_sizes[idx]) ?
1067 nvme_tcp_pdu_sizes[idx] : 0;
1070 static inline bool nvmet_tcp_pdu_valid(u8 type)
1073 case nvme_tcp_icreq:
1075 case nvme_tcp_h2c_data:
1083 static int nvmet_tcp_try_recv_pdu(struct nvmet_tcp_queue *queue)
1085 struct nvme_tcp_hdr *hdr = &queue->pdu.cmd.hdr;
1088 struct msghdr msg = { .msg_flags = MSG_DONTWAIT };
1091 iov.iov_base = (void *)&queue->pdu + queue->offset;
1092 iov.iov_len = queue->left;
1093 len = kernel_recvmsg(queue->sock, &msg, &iov, 1,
1094 iov.iov_len, msg.msg_flags);
1095 if (unlikely(len < 0))
1098 queue->offset += len;
1103 if (queue->offset == sizeof(struct nvme_tcp_hdr)) {
1104 u8 hdgst = nvmet_tcp_hdgst_len(queue);
1106 if (unlikely(!nvmet_tcp_pdu_valid(hdr->type))) {
1107 pr_err("unexpected pdu type %d\n", hdr->type);
1108 nvmet_tcp_fatal_error(queue);
1112 if (unlikely(hdr->hlen != nvmet_tcp_pdu_size(hdr->type))) {
1113 pr_err("pdu %d bad hlen %d\n", hdr->type, hdr->hlen);
1117 queue->left = hdr->hlen - queue->offset + hdgst;
1121 if (queue->hdr_digest &&
1122 nvmet_tcp_verify_hdgst(queue, &queue->pdu, hdr->hlen)) {
1123 nvmet_tcp_fatal_error(queue); /* fatal */
1127 if (queue->data_digest &&
1128 nvmet_tcp_check_ddgst(queue, &queue->pdu)) {
1129 nvmet_tcp_fatal_error(queue); /* fatal */
1133 return nvmet_tcp_done_recv_pdu(queue);
1136 static void nvmet_tcp_prep_recv_ddgst(struct nvmet_tcp_cmd *cmd)
1138 struct nvmet_tcp_queue *queue = cmd->queue;
1140 nvmet_tcp_recv_ddgst(queue->rcv_hash, cmd);
1142 queue->left = NVME_TCP_DIGEST_LENGTH;
1143 queue->rcv_state = NVMET_TCP_RECV_DDGST;
1146 static int nvmet_tcp_try_recv_data(struct nvmet_tcp_queue *queue)
1148 struct nvmet_tcp_cmd *cmd = queue->cmd;
1151 while (msg_data_left(&cmd->recv_msg)) {
1152 ret = sock_recvmsg(cmd->queue->sock, &cmd->recv_msg,
1153 cmd->recv_msg.msg_flags);
1157 cmd->pdu_recv += ret;
1158 cmd->rbytes_done += ret;
1161 nvmet_tcp_unmap_pdu_iovec(cmd);
1162 if (queue->data_digest) {
1163 nvmet_tcp_prep_recv_ddgst(cmd);
1167 if (cmd->rbytes_done == cmd->req.transfer_len)
1168 nvmet_tcp_execute_request(cmd);
1170 nvmet_prepare_receive_pdu(queue);
1174 static int nvmet_tcp_try_recv_ddgst(struct nvmet_tcp_queue *queue)
1176 struct nvmet_tcp_cmd *cmd = queue->cmd;
1178 struct msghdr msg = { .msg_flags = MSG_DONTWAIT };
1180 .iov_base = (void *)&cmd->recv_ddgst + queue->offset,
1181 .iov_len = queue->left
1184 ret = kernel_recvmsg(queue->sock, &msg, &iov, 1,
1185 iov.iov_len, msg.msg_flags);
1186 if (unlikely(ret < 0))
1189 queue->offset += ret;
1194 if (queue->data_digest && cmd->exp_ddgst != cmd->recv_ddgst) {
1195 pr_err("queue %d: cmd %d pdu (%d) data digest error: recv %#x expected %#x\n",
1196 queue->idx, cmd->req.cmd->common.command_id,
1197 queue->pdu.cmd.hdr.type, le32_to_cpu(cmd->recv_ddgst),
1198 le32_to_cpu(cmd->exp_ddgst));
1199 nvmet_tcp_finish_cmd(cmd);
1200 nvmet_tcp_fatal_error(queue);
1205 if (cmd->rbytes_done == cmd->req.transfer_len)
1206 nvmet_tcp_execute_request(cmd);
1210 nvmet_prepare_receive_pdu(queue);
1214 static int nvmet_tcp_try_recv_one(struct nvmet_tcp_queue *queue)
1218 if (unlikely(queue->rcv_state == NVMET_TCP_RECV_ERR))
1221 if (queue->rcv_state == NVMET_TCP_RECV_PDU) {
1222 result = nvmet_tcp_try_recv_pdu(queue);
1227 if (queue->rcv_state == NVMET_TCP_RECV_DATA) {
1228 result = nvmet_tcp_try_recv_data(queue);
1233 if (queue->rcv_state == NVMET_TCP_RECV_DDGST) {
1234 result = nvmet_tcp_try_recv_ddgst(queue);
1241 if (result == -EAGAIN)
1248 static int nvmet_tcp_try_recv(struct nvmet_tcp_queue *queue,
1249 int budget, int *recvs)
1253 for (i = 0; i < budget; i++) {
1254 ret = nvmet_tcp_try_recv_one(queue);
1255 if (unlikely(ret < 0)) {
1256 nvmet_tcp_socket_error(queue, ret);
1258 } else if (ret == 0) {
1267 static void nvmet_tcp_schedule_release_queue(struct nvmet_tcp_queue *queue)
1269 spin_lock(&queue->state_lock);
1270 if (queue->state != NVMET_TCP_Q_DISCONNECTING) {
1271 queue->state = NVMET_TCP_Q_DISCONNECTING;
1272 queue_work(nvmet_wq, &queue->release_work);
1274 spin_unlock(&queue->state_lock);
1277 static inline void nvmet_tcp_arm_queue_deadline(struct nvmet_tcp_queue *queue)
1279 queue->poll_end = jiffies + usecs_to_jiffies(idle_poll_period_usecs);
1282 static bool nvmet_tcp_check_queue_deadline(struct nvmet_tcp_queue *queue,
1285 if (!idle_poll_period_usecs)
1289 nvmet_tcp_arm_queue_deadline(queue);
1291 return !time_after(jiffies, queue->poll_end);
1294 static void nvmet_tcp_io_work(struct work_struct *w)
1296 struct nvmet_tcp_queue *queue =
1297 container_of(w, struct nvmet_tcp_queue, io_work);
1304 ret = nvmet_tcp_try_recv(queue, NVMET_TCP_RECV_BUDGET, &ops);
1310 ret = nvmet_tcp_try_send(queue, NVMET_TCP_SEND_BUDGET, &ops);
1316 } while (pending && ops < NVMET_TCP_IO_WORK_BUDGET);
1319 * Requeue the worker if idle deadline period is in progress or any
1320 * ops activity was recorded during the do-while loop above.
1322 if (nvmet_tcp_check_queue_deadline(queue, ops) || pending)
1323 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &queue->io_work);
1326 static int nvmet_tcp_alloc_cmd(struct nvmet_tcp_queue *queue,
1327 struct nvmet_tcp_cmd *c)
1329 u8 hdgst = nvmet_tcp_hdgst_len(queue);
1332 c->req.port = queue->port->nport;
1334 c->cmd_pdu = page_frag_alloc(&queue->pf_cache,
1335 sizeof(*c->cmd_pdu) + hdgst, GFP_KERNEL | __GFP_ZERO);
1338 c->req.cmd = &c->cmd_pdu->cmd;
1340 c->rsp_pdu = page_frag_alloc(&queue->pf_cache,
1341 sizeof(*c->rsp_pdu) + hdgst, GFP_KERNEL | __GFP_ZERO);
1344 c->req.cqe = &c->rsp_pdu->cqe;
1346 c->data_pdu = page_frag_alloc(&queue->pf_cache,
1347 sizeof(*c->data_pdu) + hdgst, GFP_KERNEL | __GFP_ZERO);
1351 c->r2t_pdu = page_frag_alloc(&queue->pf_cache,
1352 sizeof(*c->r2t_pdu) + hdgst, GFP_KERNEL | __GFP_ZERO);
1356 c->recv_msg.msg_flags = MSG_DONTWAIT | MSG_NOSIGNAL;
1358 list_add_tail(&c->entry, &queue->free_list);
1362 page_frag_free(c->data_pdu);
1364 page_frag_free(c->rsp_pdu);
1366 page_frag_free(c->cmd_pdu);
1370 static void nvmet_tcp_free_cmd(struct nvmet_tcp_cmd *c)
1372 page_frag_free(c->r2t_pdu);
1373 page_frag_free(c->data_pdu);
1374 page_frag_free(c->rsp_pdu);
1375 page_frag_free(c->cmd_pdu);
1378 static int nvmet_tcp_alloc_cmds(struct nvmet_tcp_queue *queue)
1380 struct nvmet_tcp_cmd *cmds;
1381 int i, ret = -EINVAL, nr_cmds = queue->nr_cmds;
1383 cmds = kcalloc(nr_cmds, sizeof(struct nvmet_tcp_cmd), GFP_KERNEL);
1387 for (i = 0; i < nr_cmds; i++) {
1388 ret = nvmet_tcp_alloc_cmd(queue, cmds + i);
1398 nvmet_tcp_free_cmd(cmds + i);
1404 static void nvmet_tcp_free_cmds(struct nvmet_tcp_queue *queue)
1406 struct nvmet_tcp_cmd *cmds = queue->cmds;
1409 for (i = 0; i < queue->nr_cmds; i++)
1410 nvmet_tcp_free_cmd(cmds + i);
1412 nvmet_tcp_free_cmd(&queue->connect);
1416 static void nvmet_tcp_restore_socket_callbacks(struct nvmet_tcp_queue *queue)
1418 struct socket *sock = queue->sock;
1420 write_lock_bh(&sock->sk->sk_callback_lock);
1421 sock->sk->sk_data_ready = queue->data_ready;
1422 sock->sk->sk_state_change = queue->state_change;
1423 sock->sk->sk_write_space = queue->write_space;
1424 sock->sk->sk_user_data = NULL;
1425 write_unlock_bh(&sock->sk->sk_callback_lock);
1428 static void nvmet_tcp_finish_cmd(struct nvmet_tcp_cmd *cmd)
1430 nvmet_req_uninit(&cmd->req);
1431 nvmet_tcp_unmap_pdu_iovec(cmd);
1432 nvmet_tcp_free_cmd_buffers(cmd);
1435 static void nvmet_tcp_uninit_data_in_cmds(struct nvmet_tcp_queue *queue)
1437 struct nvmet_tcp_cmd *cmd = queue->cmds;
1440 for (i = 0; i < queue->nr_cmds; i++, cmd++) {
1441 if (nvmet_tcp_need_data_in(cmd))
1442 nvmet_req_uninit(&cmd->req);
1444 nvmet_tcp_unmap_pdu_iovec(cmd);
1445 nvmet_tcp_free_cmd_buffers(cmd);
1448 if (!queue->nr_cmds && nvmet_tcp_need_data_in(&queue->connect)) {
1449 /* failed in connect */
1450 nvmet_tcp_finish_cmd(&queue->connect);
1454 static void nvmet_tcp_release_queue_work(struct work_struct *w)
1457 struct nvmet_tcp_queue *queue =
1458 container_of(w, struct nvmet_tcp_queue, release_work);
1460 mutex_lock(&nvmet_tcp_queue_mutex);
1461 list_del_init(&queue->queue_list);
1462 mutex_unlock(&nvmet_tcp_queue_mutex);
1464 nvmet_tcp_restore_socket_callbacks(queue);
1465 cancel_work_sync(&queue->io_work);
1466 /* stop accepting incoming data */
1467 queue->rcv_state = NVMET_TCP_RECV_ERR;
1469 nvmet_tcp_uninit_data_in_cmds(queue);
1470 nvmet_sq_destroy(&queue->nvme_sq);
1471 cancel_work_sync(&queue->io_work);
1472 sock_release(queue->sock);
1473 nvmet_tcp_free_cmds(queue);
1474 if (queue->hdr_digest || queue->data_digest)
1475 nvmet_tcp_free_crypto(queue);
1476 ida_free(&nvmet_tcp_queue_ida, queue->idx);
1478 page = virt_to_head_page(queue->pf_cache.va);
1479 __page_frag_cache_drain(page, queue->pf_cache.pagecnt_bias);
1483 static void nvmet_tcp_data_ready(struct sock *sk)
1485 struct nvmet_tcp_queue *queue;
1487 read_lock_bh(&sk->sk_callback_lock);
1488 queue = sk->sk_user_data;
1490 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &queue->io_work);
1491 read_unlock_bh(&sk->sk_callback_lock);
1494 static void nvmet_tcp_write_space(struct sock *sk)
1496 struct nvmet_tcp_queue *queue;
1498 read_lock_bh(&sk->sk_callback_lock);
1499 queue = sk->sk_user_data;
1500 if (unlikely(!queue))
1503 if (unlikely(queue->state == NVMET_TCP_Q_CONNECTING)) {
1504 queue->write_space(sk);
1508 if (sk_stream_is_writeable(sk)) {
1509 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1510 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &queue->io_work);
1513 read_unlock_bh(&sk->sk_callback_lock);
1516 static void nvmet_tcp_state_change(struct sock *sk)
1518 struct nvmet_tcp_queue *queue;
1520 read_lock_bh(&sk->sk_callback_lock);
1521 queue = sk->sk_user_data;
1525 switch (sk->sk_state) {
1527 case TCP_CLOSE_WAIT:
1530 nvmet_tcp_schedule_release_queue(queue);
1533 pr_warn("queue %d unhandled state %d\n",
1534 queue->idx, sk->sk_state);
1537 read_unlock_bh(&sk->sk_callback_lock);
1540 static int nvmet_tcp_set_queue_sock(struct nvmet_tcp_queue *queue)
1542 struct socket *sock = queue->sock;
1543 struct inet_sock *inet = inet_sk(sock->sk);
1546 ret = kernel_getsockname(sock,
1547 (struct sockaddr *)&queue->sockaddr);
1551 ret = kernel_getpeername(sock,
1552 (struct sockaddr *)&queue->sockaddr_peer);
1557 * Cleanup whatever is sitting in the TCP transmit queue on socket
1558 * close. This is done to prevent stale data from being sent should
1559 * the network connection be restored before TCP times out.
1561 sock_no_linger(sock->sk);
1563 if (so_priority > 0)
1564 sock_set_priority(sock->sk, so_priority);
1566 /* Set socket type of service */
1567 if (inet->rcv_tos > 0)
1568 ip_sock_set_tos(sock->sk, inet->rcv_tos);
1571 write_lock_bh(&sock->sk->sk_callback_lock);
1572 if (sock->sk->sk_state != TCP_ESTABLISHED) {
1574 * If the socket is already closing, don't even start
1579 sock->sk->sk_user_data = queue;
1580 queue->data_ready = sock->sk->sk_data_ready;
1581 sock->sk->sk_data_ready = nvmet_tcp_data_ready;
1582 queue->state_change = sock->sk->sk_state_change;
1583 sock->sk->sk_state_change = nvmet_tcp_state_change;
1584 queue->write_space = sock->sk->sk_write_space;
1585 sock->sk->sk_write_space = nvmet_tcp_write_space;
1586 if (idle_poll_period_usecs)
1587 nvmet_tcp_arm_queue_deadline(queue);
1588 queue_work_on(queue_cpu(queue), nvmet_tcp_wq, &queue->io_work);
1590 write_unlock_bh(&sock->sk->sk_callback_lock);
1595 static int nvmet_tcp_alloc_queue(struct nvmet_tcp_port *port,
1596 struct socket *newsock)
1598 struct nvmet_tcp_queue *queue;
1601 queue = kzalloc(sizeof(*queue), GFP_KERNEL);
1605 INIT_WORK(&queue->release_work, nvmet_tcp_release_queue_work);
1606 INIT_WORK(&queue->io_work, nvmet_tcp_io_work);
1607 queue->sock = newsock;
1610 spin_lock_init(&queue->state_lock);
1611 queue->state = NVMET_TCP_Q_CONNECTING;
1612 INIT_LIST_HEAD(&queue->free_list);
1613 init_llist_head(&queue->resp_list);
1614 INIT_LIST_HEAD(&queue->resp_send_list);
1616 queue->idx = ida_alloc(&nvmet_tcp_queue_ida, GFP_KERNEL);
1617 if (queue->idx < 0) {
1619 goto out_free_queue;
1622 ret = nvmet_tcp_alloc_cmd(queue, &queue->connect);
1624 goto out_ida_remove;
1626 ret = nvmet_sq_init(&queue->nvme_sq);
1628 goto out_free_connect;
1630 nvmet_prepare_receive_pdu(queue);
1632 mutex_lock(&nvmet_tcp_queue_mutex);
1633 list_add_tail(&queue->queue_list, &nvmet_tcp_queue_list);
1634 mutex_unlock(&nvmet_tcp_queue_mutex);
1636 ret = nvmet_tcp_set_queue_sock(queue);
1638 goto out_destroy_sq;
1642 mutex_lock(&nvmet_tcp_queue_mutex);
1643 list_del_init(&queue->queue_list);
1644 mutex_unlock(&nvmet_tcp_queue_mutex);
1645 nvmet_sq_destroy(&queue->nvme_sq);
1647 nvmet_tcp_free_cmd(&queue->connect);
1649 ida_free(&nvmet_tcp_queue_ida, queue->idx);
1655 static void nvmet_tcp_accept_work(struct work_struct *w)
1657 struct nvmet_tcp_port *port =
1658 container_of(w, struct nvmet_tcp_port, accept_work);
1659 struct socket *newsock;
1663 ret = kernel_accept(port->sock, &newsock, O_NONBLOCK);
1666 pr_warn("failed to accept err=%d\n", ret);
1669 ret = nvmet_tcp_alloc_queue(port, newsock);
1671 pr_err("failed to allocate queue\n");
1672 sock_release(newsock);
1677 static void nvmet_tcp_listen_data_ready(struct sock *sk)
1679 struct nvmet_tcp_port *port;
1681 read_lock_bh(&sk->sk_callback_lock);
1682 port = sk->sk_user_data;
1686 if (sk->sk_state == TCP_LISTEN)
1687 queue_work(nvmet_wq, &port->accept_work);
1689 read_unlock_bh(&sk->sk_callback_lock);
1692 static int nvmet_tcp_add_port(struct nvmet_port *nport)
1694 struct nvmet_tcp_port *port;
1695 __kernel_sa_family_t af;
1698 port = kzalloc(sizeof(*port), GFP_KERNEL);
1702 switch (nport->disc_addr.adrfam) {
1703 case NVMF_ADDR_FAMILY_IP4:
1706 case NVMF_ADDR_FAMILY_IP6:
1710 pr_err("address family %d not supported\n",
1711 nport->disc_addr.adrfam);
1716 ret = inet_pton_with_scope(&init_net, af, nport->disc_addr.traddr,
1717 nport->disc_addr.trsvcid, &port->addr);
1719 pr_err("malformed ip/port passed: %s:%s\n",
1720 nport->disc_addr.traddr, nport->disc_addr.trsvcid);
1724 port->nport = nport;
1725 INIT_WORK(&port->accept_work, nvmet_tcp_accept_work);
1726 if (port->nport->inline_data_size < 0)
1727 port->nport->inline_data_size = NVMET_TCP_DEF_INLINE_DATA_SIZE;
1729 ret = sock_create(port->addr.ss_family, SOCK_STREAM,
1730 IPPROTO_TCP, &port->sock);
1732 pr_err("failed to create a socket\n");
1736 port->sock->sk->sk_user_data = port;
1737 port->data_ready = port->sock->sk->sk_data_ready;
1738 port->sock->sk->sk_data_ready = nvmet_tcp_listen_data_ready;
1739 sock_set_reuseaddr(port->sock->sk);
1740 tcp_sock_set_nodelay(port->sock->sk);
1741 if (so_priority > 0)
1742 sock_set_priority(port->sock->sk, so_priority);
1744 ret = kernel_bind(port->sock, (struct sockaddr *)&port->addr,
1745 sizeof(port->addr));
1747 pr_err("failed to bind port socket %d\n", ret);
1751 ret = kernel_listen(port->sock, 128);
1753 pr_err("failed to listen %d on port sock\n", ret);
1758 pr_info("enabling port %d (%pISpc)\n",
1759 le16_to_cpu(nport->disc_addr.portid), &port->addr);
1764 sock_release(port->sock);
1770 static void nvmet_tcp_destroy_port_queues(struct nvmet_tcp_port *port)
1772 struct nvmet_tcp_queue *queue;
1774 mutex_lock(&nvmet_tcp_queue_mutex);
1775 list_for_each_entry(queue, &nvmet_tcp_queue_list, queue_list)
1776 if (queue->port == port)
1777 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
1778 mutex_unlock(&nvmet_tcp_queue_mutex);
1781 static void nvmet_tcp_remove_port(struct nvmet_port *nport)
1783 struct nvmet_tcp_port *port = nport->priv;
1785 write_lock_bh(&port->sock->sk->sk_callback_lock);
1786 port->sock->sk->sk_data_ready = port->data_ready;
1787 port->sock->sk->sk_user_data = NULL;
1788 write_unlock_bh(&port->sock->sk->sk_callback_lock);
1789 cancel_work_sync(&port->accept_work);
1791 * Destroy the remaining queues, which are not belong to any
1794 nvmet_tcp_destroy_port_queues(port);
1796 sock_release(port->sock);
1800 static void nvmet_tcp_delete_ctrl(struct nvmet_ctrl *ctrl)
1802 struct nvmet_tcp_queue *queue;
1804 mutex_lock(&nvmet_tcp_queue_mutex);
1805 list_for_each_entry(queue, &nvmet_tcp_queue_list, queue_list)
1806 if (queue->nvme_sq.ctrl == ctrl)
1807 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
1808 mutex_unlock(&nvmet_tcp_queue_mutex);
1811 static u16 nvmet_tcp_install_queue(struct nvmet_sq *sq)
1813 struct nvmet_tcp_queue *queue =
1814 container_of(sq, struct nvmet_tcp_queue, nvme_sq);
1817 /* Let inflight controller teardown complete */
1818 flush_workqueue(nvmet_wq);
1821 queue->nr_cmds = sq->size * 2;
1822 if (nvmet_tcp_alloc_cmds(queue))
1823 return NVME_SC_INTERNAL;
1827 static void nvmet_tcp_disc_port_addr(struct nvmet_req *req,
1828 struct nvmet_port *nport, char *traddr)
1830 struct nvmet_tcp_port *port = nport->priv;
1832 if (inet_addr_is_any((struct sockaddr *)&port->addr)) {
1833 struct nvmet_tcp_cmd *cmd =
1834 container_of(req, struct nvmet_tcp_cmd, req);
1835 struct nvmet_tcp_queue *queue = cmd->queue;
1837 sprintf(traddr, "%pISc", (struct sockaddr *)&queue->sockaddr);
1839 memcpy(traddr, nport->disc_addr.traddr, NVMF_TRADDR_SIZE);
1843 static const struct nvmet_fabrics_ops nvmet_tcp_ops = {
1844 .owner = THIS_MODULE,
1845 .type = NVMF_TRTYPE_TCP,
1847 .add_port = nvmet_tcp_add_port,
1848 .remove_port = nvmet_tcp_remove_port,
1849 .queue_response = nvmet_tcp_queue_response,
1850 .delete_ctrl = nvmet_tcp_delete_ctrl,
1851 .install_queue = nvmet_tcp_install_queue,
1852 .disc_traddr = nvmet_tcp_disc_port_addr,
1855 static int __init nvmet_tcp_init(void)
1859 nvmet_tcp_wq = alloc_workqueue("nvmet_tcp_wq", WQ_HIGHPRI, 0);
1863 ret = nvmet_register_transport(&nvmet_tcp_ops);
1869 destroy_workqueue(nvmet_tcp_wq);
1873 static void __exit nvmet_tcp_exit(void)
1875 struct nvmet_tcp_queue *queue;
1877 nvmet_unregister_transport(&nvmet_tcp_ops);
1879 flush_workqueue(nvmet_wq);
1880 mutex_lock(&nvmet_tcp_queue_mutex);
1881 list_for_each_entry(queue, &nvmet_tcp_queue_list, queue_list)
1882 kernel_sock_shutdown(queue->sock, SHUT_RDWR);
1883 mutex_unlock(&nvmet_tcp_queue_mutex);
1884 flush_workqueue(nvmet_wq);
1886 destroy_workqueue(nvmet_tcp_wq);
1889 module_init(nvmet_tcp_init);
1890 module_exit(nvmet_tcp_exit);
1892 MODULE_LICENSE("GPL v2");
1893 MODULE_ALIAS("nvmet-transport-3"); /* 3 == NVMF_TRTYPE_TCP */