xref: /linux/drivers/nvme/host/tcp.c (revision 55ab7e14222e5f0b0fd9f7711ca391d2924b35e3)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * NVMe over Fabrics TCP host.
4  * Copyright (c) 2018 Lightbits Labs. All rights reserved.
5  */
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/crc32.h>
12 #include <linux/nvme-tcp.h>
13 #include <linux/nvme-keyring.h>
14 #include <net/sock.h>
15 #include <net/tcp.h>
16 #include <net/tls.h>
17 #include <net/tls_prot.h>
18 #include <net/handshake.h>
19 #include <linux/blk-mq.h>
20 #include <net/busy_poll.h>
21 #include <trace/events/sock.h>
22 
23 #include "nvme.h"
24 #include "fabrics.h"
25 
26 struct nvme_tcp_queue;
27 
28 /*
29  * Define the socket priority to use for connections where it is desirable
30  * that the NIC consider performing optimized packet processing or filtering.
31  * A non-zero value being sufficient to indicate general consideration of any
32  * possible optimization.  Making it a module param allows for alternative
33  * values that may be unique for some NIC implementations.
34  */
35 static int so_priority;
36 module_param(so_priority, int, 0644);
37 MODULE_PARM_DESC(so_priority, "nvme tcp socket optimize priority");
38 
39 /*
40  * Use the unbound workqueue for nvme_tcp_wq, then we can set the cpu affinity
41  * from sysfs.
42  */
43 static bool wq_unbound;
44 module_param(wq_unbound, bool, 0644);
45 MODULE_PARM_DESC(wq_unbound, "Use unbound workqueue for nvme-tcp IO context (default false)");
46 
47 /*
48  * TLS handshake timeout
49  */
50 static int tls_handshake_timeout = 10;
51 #ifdef CONFIG_NVME_TCP_TLS
52 module_param(tls_handshake_timeout, int, 0644);
53 MODULE_PARM_DESC(tls_handshake_timeout,
54 		 "nvme TLS handshake timeout in seconds (default 10)");
55 #endif
56 
57 static atomic_t nvme_tcp_cpu_queues[NR_CPUS];
58 
59 enum nvme_tcp_send_state {
60 	NVME_TCP_SEND_CMD_PDU = 0,
61 	NVME_TCP_SEND_H2C_PDU,
62 	NVME_TCP_SEND_DATA,
63 	NVME_TCP_SEND_DDGST,
64 };
65 
66 struct nvme_tcp_request {
67 	struct nvme_request	req;
68 	void			*pdu;
69 	struct nvme_tcp_queue	*queue;
70 	u32			data_len;
71 	u32			pdu_len;
72 	u32			pdu_sent;
73 	u32			h2cdata_left;
74 	u32			h2cdata_offset;
75 	u16			ttag;
76 	__le16			status;
77 	struct list_head	entry;
78 	struct llist_node	lentry;
79 	__le32			ddgst;
80 
81 	struct bio		*curr_bio;
82 	struct iov_iter		iter;
83 	u32			data_recvd;
84 
85 	/* send state */
86 	size_t			offset;
87 	size_t			data_sent;
88 	enum nvme_tcp_send_state state;
89 };
90 
91 enum nvme_tcp_queue_flags {
92 	NVME_TCP_Q_ALLOCATED	= 0,
93 	NVME_TCP_Q_LIVE		= 1,
94 	NVME_TCP_Q_POLLING	= 2,
95 	NVME_TCP_Q_IO_CPU_SET	= 3,
96 };
97 
98 enum nvme_tcp_recv_state {
99 	NVME_TCP_RECV_PDU = 0,
100 	NVME_TCP_RECV_DATA,
101 	NVME_TCP_RECV_DDGST,
102 };
103 
104 struct nvme_tcp_ctrl;
105 struct nvme_tcp_queue {
106 	struct socket		*sock;
107 	struct work_struct	io_work;
108 	int			io_cpu;
109 
110 	struct mutex		queue_lock;
111 	struct mutex		send_mutex;
112 	struct mutex		pf_cache_lock;
113 	struct llist_head	req_list;
114 	struct list_head	send_list;
115 
116 	/* recv state */
117 	void			*pdu;
118 	int			pdu_remaining;
119 	int			pdu_offset;
120 	size_t			data_remaining;
121 	size_t			ddgst_remaining;
122 	unsigned int		nr_cqe;
123 
124 	/* send state */
125 	struct nvme_tcp_request *request;
126 
127 	u32			maxh2cdata;
128 	size_t			cmnd_capsule_len;
129 	struct nvme_tcp_ctrl	*ctrl;
130 	unsigned long		flags;
131 	bool			rd_enabled;
132 
133 	bool			hdr_digest;
134 	bool			data_digest;
135 	bool			tls_enabled;
136 	u32			rcv_crc;
137 	u32			snd_crc;
138 	__le32			exp_ddgst;
139 	__le32			recv_ddgst;
140 	struct completion       tls_complete;
141 	int                     tls_err;
142 	struct page_frag_cache	pf_cache;
143 
144 	void (*state_change)(struct sock *);
145 	void (*data_ready)(struct sock *);
146 	void (*write_space)(struct sock *);
147 
148 #ifdef CONFIG_DEBUG_LOCK_ALLOC
149 	struct lock_class_key nvme_tcp_sk_key;
150 	struct lock_class_key nvme_tcp_slock_key;
151 #endif
152 };
153 
154 static DEFINE_MUTEX(nvme_tcp_ctrl_mutex);
155 static LIST_HEAD_GUARDED(nvme_tcp_ctrl_list, nvme_tcp_ctrl_mutex);
156 
157 struct nvme_tcp_ctrl {
158 	/* read only in the hot path */
159 	struct nvme_tcp_queue	*queues;
160 	struct blk_mq_tag_set	tag_set;
161 
162 	/* other member variables */
163 	struct list_head	list
164 		__guarded_by(&nvme_tcp_ctrl_mutex);
165 	struct blk_mq_tag_set	admin_tag_set;
166 	struct sockaddr_storage addr;
167 	struct sockaddr_storage src_addr;
168 	struct nvme_ctrl	ctrl;
169 
170 	struct work_struct	err_work;
171 	struct delayed_work	connect_work;
172 	struct nvme_tcp_request async_req;
173 	u32			io_queues[HCTX_MAX_TYPES];
174 };
175 
176 static struct workqueue_struct *nvme_tcp_wq;
177 static const struct blk_mq_ops nvme_tcp_mq_ops;
178 static const struct blk_mq_ops nvme_tcp_admin_mq_ops;
179 static int nvme_tcp_try_send(struct nvme_tcp_queue *queue);
180 
181 #ifdef CONFIG_DEBUG_LOCK_ALLOC
182 /* lockdep can detect a circular dependency of the form
183  *   sk_lock -> mmap_lock (page fault) -> fs locks -> sk_lock
184  * because dependencies are tracked for both nvme-tcp and user contexts. Using
185  * a separate class prevents lockdep from conflating nvme-tcp socket use with
186  * user-space socket API use.
187  */
nvme_tcp_reclassify_socket(struct nvme_tcp_queue * queue)188 static void nvme_tcp_reclassify_socket(struct nvme_tcp_queue *queue)
189 {
190 	struct sock *sk = queue->sock->sk;
191 
192 	if (WARN_ON_ONCE(!sock_allow_reclassification(sk)))
193 		return;
194 
195 	switch (sk->sk_family) {
196 	case AF_INET:
197 		sock_lock_init_class_and_name(sk, "slock-AF_INET-NVME",
198 					      &queue->nvme_tcp_slock_key,
199 					      "sk_lock-AF_INET-NVME",
200 					      &queue->nvme_tcp_sk_key);
201 		break;
202 	case AF_INET6:
203 		sock_lock_init_class_and_name(sk, "slock-AF_INET6-NVME",
204 					      &queue->nvme_tcp_slock_key,
205 					      "sk_lock-AF_INET6-NVME",
206 					      &queue->nvme_tcp_sk_key);
207 		break;
208 	default:
209 		WARN_ON_ONCE(1);
210 	}
211 }
212 #endif
213 
to_tcp_ctrl(struct nvme_ctrl * ctrl)214 static inline struct nvme_tcp_ctrl *to_tcp_ctrl(struct nvme_ctrl *ctrl)
215 {
216 	return container_of(ctrl, struct nvme_tcp_ctrl, ctrl);
217 }
218 
nvme_tcp_queue_id(struct nvme_tcp_queue * queue)219 static inline int nvme_tcp_queue_id(struct nvme_tcp_queue *queue)
220 {
221 	return queue - queue->ctrl->queues;
222 }
223 
nvme_tcp_recv_pdu_supported(enum nvme_tcp_pdu_type type)224 static inline bool nvme_tcp_recv_pdu_supported(enum nvme_tcp_pdu_type type)
225 {
226 	switch (type) {
227 	case nvme_tcp_c2h_term:
228 	case nvme_tcp_c2h_data:
229 	case nvme_tcp_r2t:
230 	case nvme_tcp_rsp:
231 		return true;
232 	default:
233 		return false;
234 	}
235 }
236 
237 /*
238  * Check if the queue is TLS encrypted
239  */
nvme_tcp_queue_tls(struct nvme_tcp_queue * queue)240 static inline bool nvme_tcp_queue_tls(struct nvme_tcp_queue *queue)
241 {
242 	if (!IS_ENABLED(CONFIG_NVME_TCP_TLS))
243 		return 0;
244 
245 	return queue->tls_enabled;
246 }
247 
248 /*
249  * Check if TLS is configured for the controller.
250  */
nvme_tcp_tls_configured(struct nvme_ctrl * ctrl)251 static inline bool nvme_tcp_tls_configured(struct nvme_ctrl *ctrl)
252 {
253 	if (!IS_ENABLED(CONFIG_NVME_TCP_TLS))
254 		return 0;
255 
256 	return ctrl->opts->tls || ctrl->opts->concat;
257 }
258 
nvme_tcp_tagset(struct nvme_tcp_queue * queue)259 static inline struct blk_mq_tags *nvme_tcp_tagset(struct nvme_tcp_queue *queue)
260 {
261 	u32 queue_idx = nvme_tcp_queue_id(queue);
262 
263 	if (queue_idx == 0)
264 		return queue->ctrl->admin_tag_set.tags[queue_idx];
265 	return queue->ctrl->tag_set.tags[queue_idx - 1];
266 }
267 
nvme_tcp_hdgst_len(struct nvme_tcp_queue * queue)268 static inline u8 nvme_tcp_hdgst_len(struct nvme_tcp_queue *queue)
269 {
270 	return queue->hdr_digest ? NVME_TCP_DIGEST_LENGTH : 0;
271 }
272 
nvme_tcp_ddgst_len(struct nvme_tcp_queue * queue)273 static inline u8 nvme_tcp_ddgst_len(struct nvme_tcp_queue *queue)
274 {
275 	return queue->data_digest ? NVME_TCP_DIGEST_LENGTH : 0;
276 }
277 
nvme_tcp_req_cmd_pdu(struct nvme_tcp_request * req)278 static inline void *nvme_tcp_req_cmd_pdu(struct nvme_tcp_request *req)
279 {
280 	return req->pdu;
281 }
282 
nvme_tcp_req_data_pdu(struct nvme_tcp_request * req)283 static inline void *nvme_tcp_req_data_pdu(struct nvme_tcp_request *req)
284 {
285 	/* use the pdu space in the back for the data pdu */
286 	return req->pdu + sizeof(struct nvme_tcp_cmd_pdu) -
287 		sizeof(struct nvme_tcp_data_pdu);
288 }
289 
nvme_tcp_inline_data_size(struct nvme_tcp_request * req)290 static inline size_t nvme_tcp_inline_data_size(struct nvme_tcp_request *req)
291 {
292 	if (nvme_is_fabrics(req->req.cmd))
293 		return NVME_TCP_ADMIN_CCSZ;
294 	return req->queue->cmnd_capsule_len - sizeof(struct nvme_command);
295 }
296 
nvme_tcp_async_req(struct nvme_tcp_request * req)297 static inline bool nvme_tcp_async_req(struct nvme_tcp_request *req)
298 {
299 	return req == &req->queue->ctrl->async_req;
300 }
301 
nvme_tcp_has_inline_data(struct nvme_tcp_request * req)302 static inline bool nvme_tcp_has_inline_data(struct nvme_tcp_request *req)
303 {
304 	struct request *rq;
305 
306 	if (unlikely(nvme_tcp_async_req(req)))
307 		return false; /* async events don't have a request */
308 
309 	rq = blk_mq_rq_from_pdu(req);
310 
311 	return rq_data_dir(rq) == WRITE && req->data_len &&
312 		req->data_len <= nvme_tcp_inline_data_size(req);
313 }
314 
nvme_tcp_req_cur_page(struct nvme_tcp_request * req)315 static inline struct page *nvme_tcp_req_cur_page(struct nvme_tcp_request *req)
316 {
317 	return req->iter.bvec->bv_page;
318 }
319 
nvme_tcp_req_cur_offset(struct nvme_tcp_request * req)320 static inline size_t nvme_tcp_req_cur_offset(struct nvme_tcp_request *req)
321 {
322 	return req->iter.bvec->bv_offset + req->iter.iov_offset;
323 }
324 
nvme_tcp_req_cur_length(struct nvme_tcp_request * req)325 static inline size_t nvme_tcp_req_cur_length(struct nvme_tcp_request *req)
326 {
327 	return min_t(size_t, iov_iter_single_seg_count(&req->iter),
328 			req->pdu_len - req->pdu_sent);
329 }
330 
nvme_tcp_pdu_data_left(struct nvme_tcp_request * req)331 static inline size_t nvme_tcp_pdu_data_left(struct nvme_tcp_request *req)
332 {
333 	return rq_data_dir(blk_mq_rq_from_pdu(req)) == WRITE ?
334 			req->pdu_len - req->pdu_sent : 0;
335 }
336 
nvme_tcp_pdu_last_send(struct nvme_tcp_request * req,int len)337 static inline size_t nvme_tcp_pdu_last_send(struct nvme_tcp_request *req,
338 		int len)
339 {
340 	return nvme_tcp_pdu_data_left(req) <= len;
341 }
342 
nvme_tcp_init_iter(struct nvme_tcp_request * req,unsigned int dir)343 static void nvme_tcp_init_iter(struct nvme_tcp_request *req,
344 		unsigned int dir)
345 {
346 	struct request *rq = blk_mq_rq_from_pdu(req);
347 
348 	if (rq->rq_flags & RQF_SPECIAL_PAYLOAD) {
349 		iov_iter_bvec(&req->iter, dir, &rq->special_vec, 1,
350 				blk_rq_payload_bytes(rq));
351 		req->iter.iov_offset = 0;
352 	} else {
353 		struct bio *bio = req->curr_bio;
354 		struct bvec_iter bi;
355 		struct bio_vec bv;
356 		int nr_bvec = 0;
357 
358 		bio_for_each_bvec(bv, bio, bi)
359 			nr_bvec++;
360 
361 		iov_iter_bvec(&req->iter, dir,
362 			__bvec_iter_bvec(bio->bi_io_vec, bio->bi_iter), nr_bvec,
363 			bio->bi_iter.bi_size);
364 		req->iter.iov_offset = bio->bi_iter.bi_offset;
365 	}
366 }
367 
nvme_tcp_advance_req(struct nvme_tcp_request * req,int len)368 static inline void nvme_tcp_advance_req(struct nvme_tcp_request *req,
369 		int len)
370 {
371 	req->data_sent += len;
372 	req->pdu_sent += len;
373 	iov_iter_advance(&req->iter, len);
374 	if (!iov_iter_count(&req->iter) &&
375 	    req->data_sent < req->data_len) {
376 		req->curr_bio = req->curr_bio->bi_next;
377 		nvme_tcp_init_iter(req, ITER_SOURCE);
378 	}
379 }
380 
nvme_tcp_send_all(struct nvme_tcp_queue * queue)381 static inline void nvme_tcp_send_all(struct nvme_tcp_queue *queue)
382 {
383 	int ret;
384 
385 	/* drain the send queue as much as we can... */
386 	do {
387 		ret = nvme_tcp_try_send(queue);
388 	} while (ret > 0);
389 }
390 
nvme_tcp_queue_has_pending(struct nvme_tcp_queue * queue)391 static inline bool nvme_tcp_queue_has_pending(struct nvme_tcp_queue *queue)
392 {
393 	return !list_empty(&queue->send_list) ||
394 		!llist_empty(&queue->req_list);
395 }
396 
nvme_tcp_queue_more(struct nvme_tcp_queue * queue)397 static inline bool nvme_tcp_queue_more(struct nvme_tcp_queue *queue)
398 {
399 	return !nvme_tcp_queue_tls(queue) &&
400 		nvme_tcp_queue_has_pending(queue);
401 }
402 
nvme_tcp_queue_request(struct nvme_tcp_request * req,bool last)403 static inline void nvme_tcp_queue_request(struct nvme_tcp_request *req,
404 		bool last)
405 {
406 	struct nvme_tcp_queue *queue = req->queue;
407 	bool empty;
408 
409 	empty = llist_add(&req->lentry, &queue->req_list) &&
410 		list_empty(&queue->send_list) && !queue->request;
411 
412 	/*
413 	 * if we're the first on the send_list and we can try to send
414 	 * directly, otherwise queue io_work. Also, only do that if we
415 	 * are on the same cpu, so we don't introduce contention.
416 	 */
417 	if (queue->io_cpu == raw_smp_processor_id() &&
418 	    empty && mutex_trylock(&queue->send_mutex)) {
419 		nvme_tcp_send_all(queue);
420 		mutex_unlock(&queue->send_mutex);
421 	}
422 
423 	if (last && nvme_tcp_queue_has_pending(queue))
424 		queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
425 }
426 
nvme_tcp_process_req_list(struct nvme_tcp_queue * queue)427 static void nvme_tcp_process_req_list(struct nvme_tcp_queue *queue)
428 {
429 	struct nvme_tcp_request *req;
430 	struct llist_node *node;
431 
432 	for (node = llist_del_all(&queue->req_list); node; node = node->next) {
433 		req = llist_entry(node, struct nvme_tcp_request, lentry);
434 		list_add(&req->entry, &queue->send_list);
435 	}
436 }
437 
438 static inline struct nvme_tcp_request *
nvme_tcp_fetch_request(struct nvme_tcp_queue * queue)439 nvme_tcp_fetch_request(struct nvme_tcp_queue *queue)
440 {
441 	struct nvme_tcp_request *req;
442 
443 	req = list_first_entry_or_null(&queue->send_list,
444 			struct nvme_tcp_request, entry);
445 	if (!req) {
446 		nvme_tcp_process_req_list(queue);
447 		req = list_first_entry_or_null(&queue->send_list,
448 				struct nvme_tcp_request, entry);
449 		if (unlikely(!req))
450 			return NULL;
451 	}
452 
453 	list_del_init(&req->entry);
454 	init_llist_node(&req->lentry);
455 	return req;
456 }
457 
458 #define NVME_TCP_CRC_SEED (~0)
459 
nvme_tcp_ddgst_update(u32 * crcp,struct page * page,size_t off,size_t len)460 static inline void nvme_tcp_ddgst_update(u32 *crcp,
461 		struct page *page, size_t off, size_t len)
462 {
463 	page += off / PAGE_SIZE;
464 	off %= PAGE_SIZE;
465 	while (len) {
466 		const void *vaddr = kmap_local_page(page);
467 		size_t n = min(len, (size_t)PAGE_SIZE - off);
468 
469 		*crcp = crc32c(*crcp, vaddr + off, n);
470 		kunmap_local(vaddr);
471 		page++;
472 		off = 0;
473 		len -= n;
474 	}
475 }
476 
nvme_tcp_ddgst_final(u32 crc)477 static inline __le32 nvme_tcp_ddgst_final(u32 crc)
478 {
479 	return cpu_to_le32(~crc);
480 }
481 
nvme_tcp_hdgst(const void * pdu,size_t len)482 static inline __le32 nvme_tcp_hdgst(const void *pdu, size_t len)
483 {
484 	return cpu_to_le32(~crc32c(NVME_TCP_CRC_SEED, pdu, len));
485 }
486 
nvme_tcp_set_hdgst(void * pdu,size_t len)487 static inline void nvme_tcp_set_hdgst(void *pdu, size_t len)
488 {
489 	*(__le32 *)(pdu + len) = nvme_tcp_hdgst(pdu, len);
490 }
491 
nvme_tcp_verify_hdgst(struct nvme_tcp_queue * queue,void * pdu,size_t pdu_len)492 static int nvme_tcp_verify_hdgst(struct nvme_tcp_queue *queue,
493 		void *pdu, size_t pdu_len)
494 {
495 	struct nvme_tcp_hdr *hdr = pdu;
496 	__le32 recv_digest;
497 	__le32 exp_digest;
498 
499 	if (unlikely(!(hdr->flags & NVME_TCP_F_HDGST))) {
500 		dev_err(queue->ctrl->ctrl.device,
501 			"queue %d: header digest flag is cleared\n",
502 			nvme_tcp_queue_id(queue));
503 		return -EPROTO;
504 	}
505 
506 	recv_digest = *(__le32 *)(pdu + hdr->hlen);
507 	exp_digest = nvme_tcp_hdgst(pdu, pdu_len);
508 	if (recv_digest != exp_digest) {
509 		dev_err(queue->ctrl->ctrl.device,
510 			"header digest error: recv %#x expected %#x\n",
511 			le32_to_cpu(recv_digest), le32_to_cpu(exp_digest));
512 		return -EIO;
513 	}
514 
515 	return 0;
516 }
517 
nvme_tcp_check_ddgst(struct nvme_tcp_queue * queue,void * pdu)518 static int nvme_tcp_check_ddgst(struct nvme_tcp_queue *queue, void *pdu)
519 {
520 	struct nvme_tcp_hdr *hdr = pdu;
521 	u8 digest_len = nvme_tcp_hdgst_len(queue);
522 	u32 len;
523 
524 	len = le32_to_cpu(hdr->plen) - hdr->hlen -
525 		((hdr->flags & NVME_TCP_F_HDGST) ? digest_len : 0);
526 
527 	if (unlikely(len && !(hdr->flags & NVME_TCP_F_DDGST))) {
528 		dev_err(queue->ctrl->ctrl.device,
529 			"queue %d: data digest flag is cleared\n",
530 		nvme_tcp_queue_id(queue));
531 		return -EPROTO;
532 	}
533 	queue->rcv_crc = NVME_TCP_CRC_SEED;
534 
535 	return 0;
536 }
537 
nvme_tcp_exit_request(struct blk_mq_tag_set * set,struct request * rq,unsigned int hctx_idx)538 static void nvme_tcp_exit_request(struct blk_mq_tag_set *set,
539 		struct request *rq, unsigned int hctx_idx)
540 {
541 	struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
542 
543 	page_frag_free(req->pdu);
544 }
545 
nvme_tcp_init_request(struct blk_mq_tag_set * set,struct request * rq,unsigned int hctx_idx,int numa_node)546 static int nvme_tcp_init_request(struct blk_mq_tag_set *set,
547 		struct request *rq, unsigned int hctx_idx,
548 		int numa_node)
549 {
550 	struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(set->driver_data);
551 	struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
552 	struct nvme_tcp_cmd_pdu *pdu;
553 	int queue_idx = (set == &ctrl->tag_set) ? hctx_idx + 1 : 0;
554 	struct nvme_tcp_queue *queue = &ctrl->queues[queue_idx];
555 	u8 hdgst = nvme_tcp_hdgst_len(queue);
556 
557 	mutex_lock(&queue->pf_cache_lock);
558 	req->pdu = page_frag_alloc(&queue->pf_cache,
559 		sizeof(struct nvme_tcp_cmd_pdu) + hdgst,
560 		GFP_KERNEL | __GFP_ZERO);
561 	mutex_unlock(&queue->pf_cache_lock);
562 	if (!req->pdu)
563 		return -ENOMEM;
564 
565 	pdu = req->pdu;
566 	req->queue = queue;
567 	nvme_req(rq)->ctrl = &ctrl->ctrl;
568 	nvme_req(rq)->cmd = &pdu->cmd;
569 	init_llist_node(&req->lentry);
570 	INIT_LIST_HEAD(&req->entry);
571 
572 	return 0;
573 }
574 
nvme_tcp_init_hctx(struct blk_mq_hw_ctx * hctx,void * data,unsigned int hctx_idx)575 static int nvme_tcp_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
576 		unsigned int hctx_idx)
577 {
578 	struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(data);
579 	struct nvme_tcp_queue *queue = &ctrl->queues[hctx_idx + 1];
580 
581 	hctx->driver_data = queue;
582 	return 0;
583 }
584 
nvme_tcp_init_admin_hctx(struct blk_mq_hw_ctx * hctx,void * data,unsigned int hctx_idx)585 static int nvme_tcp_init_admin_hctx(struct blk_mq_hw_ctx *hctx, void *data,
586 		unsigned int hctx_idx)
587 {
588 	struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(data);
589 	struct nvme_tcp_queue *queue = &ctrl->queues[0];
590 
591 	hctx->driver_data = queue;
592 	return 0;
593 }
594 
595 static enum nvme_tcp_recv_state
nvme_tcp_recv_state(struct nvme_tcp_queue * queue)596 nvme_tcp_recv_state(struct nvme_tcp_queue *queue)
597 {
598 	return  (queue->pdu_remaining) ? NVME_TCP_RECV_PDU :
599 		(queue->ddgst_remaining) ? NVME_TCP_RECV_DDGST :
600 		NVME_TCP_RECV_DATA;
601 }
602 
nvme_tcp_init_recv_ctx(struct nvme_tcp_queue * queue)603 static void nvme_tcp_init_recv_ctx(struct nvme_tcp_queue *queue)
604 {
605 	queue->pdu_remaining = sizeof(struct nvme_tcp_rsp_pdu) +
606 				nvme_tcp_hdgst_len(queue);
607 	queue->pdu_offset = 0;
608 	queue->data_remaining = -1;
609 	queue->ddgst_remaining = 0;
610 }
611 
nvme_tcp_error_recovery(struct nvme_ctrl * ctrl)612 static void nvme_tcp_error_recovery(struct nvme_ctrl *ctrl)
613 {
614 	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING))
615 		return;
616 
617 	dev_warn(ctrl->device, "starting error recovery\n");
618 	queue_work(nvme_reset_wq, &to_tcp_ctrl(ctrl)->err_work);
619 }
620 
621 /*
622  * NVMe has no short read: a read that completes successfully must
623  * have transferred everything it asked for.
624  */
nvme_tcp_data_in_short(struct nvme_tcp_queue * queue,struct request * rq)625 static bool nvme_tcp_data_in_short(struct nvme_tcp_queue *queue,
626 				   struct request *rq)
627 {
628 	struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
629 
630 	if (le16_to_cpu(req->status) >> 1)
631 		return false;
632 	if (req_op(rq) != REQ_OP_READ || !req->data_len)
633 		return false;
634 	if (likely(req->data_recvd == req->data_len))
635 		return false;
636 
637 	dev_err(queue->ctrl->ctrl.device,
638 		"queue %d tag %#x short data-in: got %u of %u\n",
639 		nvme_tcp_queue_id(queue), rq->tag,
640 		req->data_recvd, req->data_len);
641 	return true;
642 }
643 
nvme_tcp_process_nvme_cqe(struct nvme_tcp_queue * queue,struct nvme_completion * cqe)644 static int nvme_tcp_process_nvme_cqe(struct nvme_tcp_queue *queue,
645 		struct nvme_completion *cqe)
646 {
647 	struct nvme_tcp_request *req;
648 	struct request *rq;
649 
650 	rq = nvme_find_rq(nvme_tcp_tagset(queue), cqe->command_id);
651 	if (!rq) {
652 		dev_err(queue->ctrl->ctrl.device,
653 			"got bad cqe.command_id %#x on queue %d\n",
654 			cqe->command_id, nvme_tcp_queue_id(queue));
655 		nvme_tcp_error_recovery(&queue->ctrl->ctrl);
656 		return -EINVAL;
657 	}
658 
659 	req = blk_mq_rq_to_pdu(rq);
660 	if (req->status == cpu_to_le16(NVME_SC_SUCCESS))
661 		req->status = cqe->status;
662 
663 	if (unlikely(nvme_tcp_data_in_short(queue, rq)))
664 		return -EPROTO;
665 
666 	if (!nvme_try_complete_req(rq, req->status, cqe->result))
667 		nvme_complete_rq(rq);
668 	queue->nr_cqe++;
669 
670 	return 0;
671 }
672 
nvme_tcp_handle_c2h_data(struct nvme_tcp_queue * queue,struct nvme_tcp_data_pdu * pdu)673 static int nvme_tcp_handle_c2h_data(struct nvme_tcp_queue *queue,
674 		struct nvme_tcp_data_pdu *pdu)
675 {
676 	struct nvme_tcp_request *req;
677 	struct request *rq;
678 
679 	rq = nvme_find_rq(nvme_tcp_tagset(queue), pdu->command_id);
680 	if (!rq) {
681 		dev_err(queue->ctrl->ctrl.device,
682 			"got bad c2hdata.command_id %#x on queue %d\n",
683 			pdu->command_id, nvme_tcp_queue_id(queue));
684 		return -ENOENT;
685 	}
686 
687 	req = blk_mq_rq_to_pdu(rq);
688 	if (!blk_rq_payload_bytes(rq) || !req->curr_bio || !req->data_len) {
689 		dev_err(queue->ctrl->ctrl.device,
690 			"queue %d tag %#x unexpected data\n",
691 			nvme_tcp_queue_id(queue), rq->tag);
692 		return -EIO;
693 	}
694 
695 	queue->data_remaining = le32_to_cpu(pdu->data_length);
696 
697 	if (pdu->hdr.flags & NVME_TCP_F_DATA_SUCCESS &&
698 	    unlikely(!(pdu->hdr.flags & NVME_TCP_F_DATA_LAST))) {
699 		dev_err(queue->ctrl->ctrl.device,
700 			"queue %d tag %#x SUCCESS set but not last PDU\n",
701 			nvme_tcp_queue_id(queue), rq->tag);
702 		nvme_tcp_error_recovery(&queue->ctrl->ctrl);
703 		return -EPROTO;
704 	}
705 
706 	return 0;
707 }
708 
nvme_tcp_handle_comp(struct nvme_tcp_queue * queue,struct nvme_tcp_rsp_pdu * pdu)709 static int nvme_tcp_handle_comp(struct nvme_tcp_queue *queue,
710 		struct nvme_tcp_rsp_pdu *pdu)
711 {
712 	struct nvme_completion *cqe = &pdu->cqe;
713 	int ret = 0;
714 
715 	/*
716 	 * AEN requests are special as they don't time out and can
717 	 * survive any kind of queue freeze and often don't respond to
718 	 * aborts.  We don't even bother to allocate a struct request
719 	 * for them but rather special case them here.
720 	 */
721 	if (unlikely(nvme_is_aen_req(nvme_tcp_queue_id(queue),
722 				     cqe->command_id)))
723 		nvme_complete_async_event(&queue->ctrl->ctrl, cqe->status,
724 				&cqe->result);
725 	else
726 		ret = nvme_tcp_process_nvme_cqe(queue, cqe);
727 
728 	return ret;
729 }
730 
nvme_tcp_setup_h2c_data_pdu(struct nvme_tcp_request * req)731 static void nvme_tcp_setup_h2c_data_pdu(struct nvme_tcp_request *req)
732 {
733 	struct nvme_tcp_data_pdu *data = nvme_tcp_req_data_pdu(req);
734 	struct nvme_tcp_queue *queue = req->queue;
735 	struct request *rq = blk_mq_rq_from_pdu(req);
736 	u32 h2cdata_sent = req->pdu_len;
737 	u8 hdgst = nvme_tcp_hdgst_len(queue);
738 	u8 ddgst = nvme_tcp_ddgst_len(queue);
739 
740 	req->state = NVME_TCP_SEND_H2C_PDU;
741 	req->offset = 0;
742 	req->pdu_len = min(req->h2cdata_left, queue->maxh2cdata);
743 	req->pdu_sent = 0;
744 	req->h2cdata_left -= req->pdu_len;
745 	req->h2cdata_offset += h2cdata_sent;
746 
747 	memset(data, 0, sizeof(*data));
748 	data->hdr.type = nvme_tcp_h2c_data;
749 	if (!req->h2cdata_left)
750 		data->hdr.flags = NVME_TCP_F_DATA_LAST;
751 	if (queue->hdr_digest)
752 		data->hdr.flags |= NVME_TCP_F_HDGST;
753 	if (queue->data_digest)
754 		data->hdr.flags |= NVME_TCP_F_DDGST;
755 	data->hdr.hlen = sizeof(*data);
756 	data->hdr.pdo = data->hdr.hlen + hdgst;
757 	data->hdr.plen =
758 		cpu_to_le32(data->hdr.hlen + hdgst + req->pdu_len + ddgst);
759 	data->ttag = req->ttag;
760 	data->command_id = nvme_cid(rq);
761 	data->data_offset = cpu_to_le32(req->h2cdata_offset);
762 	data->data_length = cpu_to_le32(req->pdu_len);
763 }
764 
nvme_tcp_handle_r2t(struct nvme_tcp_queue * queue,struct nvme_tcp_r2t_pdu * pdu)765 static int nvme_tcp_handle_r2t(struct nvme_tcp_queue *queue,
766 		struct nvme_tcp_r2t_pdu *pdu)
767 {
768 	struct nvme_tcp_request *req;
769 	struct request *rq;
770 	u32 r2t_length = le32_to_cpu(pdu->r2t_length);
771 	u32 r2t_offset = le32_to_cpu(pdu->r2t_offset);
772 
773 	rq = nvme_find_rq(nvme_tcp_tagset(queue), pdu->command_id);
774 	if (!rq) {
775 		dev_err(queue->ctrl->ctrl.device,
776 			"got bad r2t.command_id %#x on queue %d\n",
777 			pdu->command_id, nvme_tcp_queue_id(queue));
778 		return -ENOENT;
779 	}
780 	req = blk_mq_rq_to_pdu(rq);
781 
782 	if (unlikely(rq_data_dir(rq) != WRITE)) {
783 		dev_err(queue->ctrl->ctrl.device,
784 			"req %d unexpected r2t for a non-write command\n",
785 			rq->tag);
786 		return -EPROTO;
787 	}
788 
789 	if (unlikely(!r2t_length)) {
790 		dev_err(queue->ctrl->ctrl.device,
791 			"req %d r2t len is %u, probably a bug...\n",
792 			rq->tag, r2t_length);
793 		return -EPROTO;
794 	}
795 
796 	if (unlikely(req->data_sent + r2t_length > req->data_len)) {
797 		dev_err(queue->ctrl->ctrl.device,
798 			"req %d r2t len %u exceeded data len %u (%zu sent)\n",
799 			rq->tag, r2t_length, req->data_len, req->data_sent);
800 		return -EPROTO;
801 	}
802 
803 	if (unlikely(r2t_offset < req->data_sent)) {
804 		dev_err(queue->ctrl->ctrl.device,
805 			"req %d unexpected r2t offset %u (expected %zu)\n",
806 			rq->tag, r2t_offset, req->data_sent);
807 		return -EPROTO;
808 	}
809 
810 	if (llist_on_list(&req->lentry) ||
811 	    !list_empty(&req->entry)) {
812 		dev_err(queue->ctrl->ctrl.device,
813 			"req %d unexpected r2t while processing request\n",
814 			rq->tag);
815 		return -EPROTO;
816 	}
817 
818 	req->pdu_len = 0;
819 	req->h2cdata_left = r2t_length;
820 	req->h2cdata_offset = r2t_offset;
821 	req->ttag = pdu->ttag;
822 
823 	nvme_tcp_setup_h2c_data_pdu(req);
824 
825 	llist_add(&req->lentry, &queue->req_list);
826 	queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
827 
828 	return 0;
829 }
830 
nvme_tcp_handle_c2h_term(struct nvme_tcp_queue * queue,struct nvme_tcp_term_pdu * pdu)831 static void nvme_tcp_handle_c2h_term(struct nvme_tcp_queue *queue,
832 		struct nvme_tcp_term_pdu *pdu)
833 {
834 	u16 fes;
835 	const char *msg;
836 	u32 plen = le32_to_cpu(pdu->hdr.plen);
837 
838 	static const char * const msg_table[] = {
839 		[NVME_TCP_FES_INVALID_PDU_HDR] = "Invalid PDU Header Field",
840 		[NVME_TCP_FES_PDU_SEQ_ERR] = "PDU Sequence Error",
841 		[NVME_TCP_FES_HDR_DIGEST_ERR] = "Header Digest Error",
842 		[NVME_TCP_FES_DATA_OUT_OF_RANGE] = "Data Transfer Out Of Range",
843 		[NVME_TCP_FES_DATA_LIMIT_EXCEEDED] = "Data Transfer Limit Exceeded",
844 		[NVME_TCP_FES_UNSUPPORTED_PARAM] = "Unsupported Parameter",
845 	};
846 
847 	if (plen < NVME_TCP_MIN_C2HTERM_PLEN ||
848 	    plen > NVME_TCP_MAX_C2HTERM_PLEN) {
849 		dev_err(queue->ctrl->ctrl.device,
850 			"Received a malformed C2HTermReq PDU (plen = %u)\n",
851 			plen);
852 		return;
853 	}
854 
855 	fes = le16_to_cpu(pdu->fes);
856 	if (fes && fes < ARRAY_SIZE(msg_table))
857 		msg = msg_table[fes];
858 	else
859 		msg = "Unknown";
860 
861 	dev_err(queue->ctrl->ctrl.device,
862 		"Received C2HTermReq (FES = %s)\n", msg);
863 }
864 
nvme_tcp_recv_pdu(struct nvme_tcp_queue * queue,struct sk_buff * skb,unsigned int * offset,size_t * len)865 static int nvme_tcp_recv_pdu(struct nvme_tcp_queue *queue, struct sk_buff *skb,
866 		unsigned int *offset, size_t *len)
867 {
868 	struct nvme_tcp_hdr *hdr;
869 	char *pdu = queue->pdu;
870 	size_t rcv_len = min_t(size_t, *len, queue->pdu_remaining);
871 	int ret;
872 
873 	ret = skb_copy_bits(skb, *offset,
874 		&pdu[queue->pdu_offset], rcv_len);
875 	if (unlikely(ret))
876 		return ret;
877 
878 	queue->pdu_remaining -= rcv_len;
879 	queue->pdu_offset += rcv_len;
880 	*offset += rcv_len;
881 	*len -= rcv_len;
882 	if (queue->pdu_remaining)
883 		return 0;
884 
885 	hdr = queue->pdu;
886 	if (unlikely(hdr->hlen != sizeof(struct nvme_tcp_rsp_pdu))) {
887 		if (!nvme_tcp_recv_pdu_supported(hdr->type))
888 			goto unsupported_pdu;
889 
890 		dev_err(queue->ctrl->ctrl.device,
891 			"pdu type %d has unexpected header length (%d)\n",
892 			hdr->type, hdr->hlen);
893 		return -EPROTO;
894 	}
895 
896 	if (unlikely(hdr->type == nvme_tcp_c2h_term)) {
897 		/*
898 		 * C2HTermReq never includes Header or Data digests.
899 		 * Skip the checks.
900 		 */
901 		nvme_tcp_handle_c2h_term(queue, (void *)queue->pdu);
902 		return -EINVAL;
903 	}
904 
905 	if (queue->hdr_digest) {
906 		ret = nvme_tcp_verify_hdgst(queue, queue->pdu, hdr->hlen);
907 		if (unlikely(ret))
908 			return ret;
909 	}
910 
911 
912 	if (queue->data_digest) {
913 		ret = nvme_tcp_check_ddgst(queue, queue->pdu);
914 		if (unlikely(ret))
915 			return ret;
916 	}
917 
918 	switch (hdr->type) {
919 	case nvme_tcp_c2h_data:
920 		return nvme_tcp_handle_c2h_data(queue, (void *)queue->pdu);
921 	case nvme_tcp_rsp:
922 		nvme_tcp_init_recv_ctx(queue);
923 		return nvme_tcp_handle_comp(queue, (void *)queue->pdu);
924 	case nvme_tcp_r2t:
925 		nvme_tcp_init_recv_ctx(queue);
926 		return nvme_tcp_handle_r2t(queue, (void *)queue->pdu);
927 	default:
928 		goto unsupported_pdu;
929 	}
930 
931 unsupported_pdu:
932 	dev_err(queue->ctrl->ctrl.device,
933 		"unsupported pdu type (%d)\n", hdr->type);
934 	return -EINVAL;
935 }
936 
nvme_tcp_end_request(struct request * rq,u16 status)937 static inline void nvme_tcp_end_request(struct request *rq, u16 status)
938 {
939 	union nvme_result res = {};
940 
941 	if (!nvme_try_complete_req(rq, cpu_to_le16(status << 1), res))
942 		nvme_complete_rq(rq);
943 }
944 
nvme_tcp_recv_data(struct nvme_tcp_queue * queue,struct sk_buff * skb,unsigned int * offset,size_t * len)945 static int nvme_tcp_recv_data(struct nvme_tcp_queue *queue, struct sk_buff *skb,
946 			      unsigned int *offset, size_t *len)
947 {
948 	struct nvme_tcp_data_pdu *pdu = (void *)queue->pdu;
949 	struct request *rq =
950 		nvme_cid_to_rq(nvme_tcp_tagset(queue), pdu->command_id);
951 	struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
952 
953 	while (true) {
954 		int recv_len, ret;
955 
956 		recv_len = min_t(size_t, *len, queue->data_remaining);
957 		if (!recv_len)
958 			break;
959 
960 		if (!iov_iter_count(&req->iter)) {
961 			req->curr_bio = req->curr_bio->bi_next;
962 
963 			/*
964 			 * If we don't have any bios it means the controller
965 			 * sent more data than we requested, hence error
966 			 */
967 			if (!req->curr_bio) {
968 				dev_err(queue->ctrl->ctrl.device,
969 					"queue %d no space in request %#x",
970 					nvme_tcp_queue_id(queue), rq->tag);
971 				nvme_tcp_init_recv_ctx(queue);
972 				return -EIO;
973 			}
974 			nvme_tcp_init_iter(req, ITER_DEST);
975 		}
976 
977 		/* we can read only from what is left in this bio */
978 		recv_len = min_t(size_t, recv_len,
979 				iov_iter_count(&req->iter));
980 
981 		if (queue->data_digest)
982 			ret = skb_copy_and_crc32c_datagram_iter(skb, *offset,
983 				&req->iter, recv_len, &queue->rcv_crc);
984 		else
985 			ret = skb_copy_datagram_iter(skb, *offset,
986 					&req->iter, recv_len);
987 		if (ret) {
988 			dev_err(queue->ctrl->ctrl.device,
989 				"queue %d failed to copy request %#x data",
990 				nvme_tcp_queue_id(queue), rq->tag);
991 			return ret;
992 		}
993 
994 		*len -= recv_len;
995 		*offset += recv_len;
996 		queue->data_remaining -= recv_len;
997 		req->data_recvd += recv_len;
998 	}
999 
1000 	if (!queue->data_remaining) {
1001 		if (queue->data_digest) {
1002 			queue->exp_ddgst = nvme_tcp_ddgst_final(queue->rcv_crc);
1003 			queue->ddgst_remaining = NVME_TCP_DIGEST_LENGTH;
1004 		} else {
1005 			if (pdu->hdr.flags & NVME_TCP_F_DATA_SUCCESS) {
1006 				if (unlikely(nvme_tcp_data_in_short(queue, rq)))
1007 					return -EPROTO;
1008 				nvme_tcp_end_request(rq,
1009 						le16_to_cpu(req->status));
1010 				queue->nr_cqe++;
1011 			}
1012 			nvme_tcp_init_recv_ctx(queue);
1013 		}
1014 	}
1015 
1016 	return 0;
1017 }
1018 
nvme_tcp_recv_ddgst(struct nvme_tcp_queue * queue,struct sk_buff * skb,unsigned int * offset,size_t * len)1019 static int nvme_tcp_recv_ddgst(struct nvme_tcp_queue *queue,
1020 		struct sk_buff *skb, unsigned int *offset, size_t *len)
1021 {
1022 	struct nvme_tcp_data_pdu *pdu = (void *)queue->pdu;
1023 	char *ddgst = (char *)&queue->recv_ddgst;
1024 	size_t recv_len = min_t(size_t, *len, queue->ddgst_remaining);
1025 	off_t off = NVME_TCP_DIGEST_LENGTH - queue->ddgst_remaining;
1026 	int ret;
1027 
1028 	ret = skb_copy_bits(skb, *offset, &ddgst[off], recv_len);
1029 	if (unlikely(ret))
1030 		return ret;
1031 
1032 	queue->ddgst_remaining -= recv_len;
1033 	*offset += recv_len;
1034 	*len -= recv_len;
1035 	if (queue->ddgst_remaining)
1036 		return 0;
1037 
1038 	if (queue->recv_ddgst != queue->exp_ddgst) {
1039 		struct request *rq = nvme_cid_to_rq(nvme_tcp_tagset(queue),
1040 					pdu->command_id);
1041 		struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
1042 
1043 		req->status = cpu_to_le16(NVME_SC_DATA_XFER_ERROR);
1044 
1045 		dev_err(queue->ctrl->ctrl.device,
1046 			"data digest error: recv %#x expected %#x\n",
1047 			le32_to_cpu(queue->recv_ddgst),
1048 			le32_to_cpu(queue->exp_ddgst));
1049 	}
1050 
1051 	if (pdu->hdr.flags & NVME_TCP_F_DATA_SUCCESS) {
1052 		struct request *rq = nvme_cid_to_rq(nvme_tcp_tagset(queue),
1053 					pdu->command_id);
1054 		struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
1055 
1056 		if (unlikely(nvme_tcp_data_in_short(queue, rq)))
1057 			return -EPROTO;
1058 
1059 		nvme_tcp_end_request(rq, le16_to_cpu(req->status));
1060 		queue->nr_cqe++;
1061 	}
1062 
1063 	nvme_tcp_init_recv_ctx(queue);
1064 	return 0;
1065 }
1066 
nvme_tcp_recv_skb(read_descriptor_t * desc,struct sk_buff * skb,unsigned int offset,size_t len)1067 static int nvme_tcp_recv_skb(read_descriptor_t *desc, struct sk_buff *skb,
1068 			     unsigned int offset, size_t len)
1069 {
1070 	struct nvme_tcp_queue *queue = desc->arg.data;
1071 	size_t consumed = len;
1072 	int result;
1073 
1074 	if (unlikely(!queue->rd_enabled))
1075 		return -EFAULT;
1076 
1077 	while (len) {
1078 		switch (nvme_tcp_recv_state(queue)) {
1079 		case NVME_TCP_RECV_PDU:
1080 			result = nvme_tcp_recv_pdu(queue, skb, &offset, &len);
1081 			break;
1082 		case NVME_TCP_RECV_DATA:
1083 			result = nvme_tcp_recv_data(queue, skb, &offset, &len);
1084 			break;
1085 		case NVME_TCP_RECV_DDGST:
1086 			result = nvme_tcp_recv_ddgst(queue, skb, &offset, &len);
1087 			break;
1088 		default:
1089 			result = -EFAULT;
1090 		}
1091 		if (result) {
1092 			dev_err(queue->ctrl->ctrl.device,
1093 				"receive failed:  %d\n", result);
1094 			queue->rd_enabled = false;
1095 			nvme_tcp_error_recovery(&queue->ctrl->ctrl);
1096 			return result;
1097 		}
1098 	}
1099 
1100 	return consumed;
1101 }
1102 
nvme_tcp_data_ready(struct sock * sk)1103 static void nvme_tcp_data_ready(struct sock *sk)
1104 {
1105 	struct nvme_tcp_queue *queue;
1106 
1107 	trace_sk_data_ready(sk);
1108 
1109 	read_lock_bh(&sk->sk_callback_lock);
1110 	queue = sk->sk_user_data;
1111 	if (likely(queue && queue->rd_enabled) &&
1112 	    !test_bit(NVME_TCP_Q_POLLING, &queue->flags))
1113 		queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
1114 	read_unlock_bh(&sk->sk_callback_lock);
1115 }
1116 
nvme_tcp_write_space(struct sock * sk)1117 static void nvme_tcp_write_space(struct sock *sk)
1118 {
1119 	struct nvme_tcp_queue *queue;
1120 
1121 	read_lock_bh(&sk->sk_callback_lock);
1122 	queue = sk->sk_user_data;
1123 	if (likely(queue && sk_stream_is_writeable(sk))) {
1124 		clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1125 		/* Ensure pending TLS partial records are retried */
1126 		if (nvme_tcp_queue_tls(queue))
1127 			queue->write_space(sk);
1128 		queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
1129 	}
1130 	read_unlock_bh(&sk->sk_callback_lock);
1131 }
1132 
nvme_tcp_state_change(struct sock * sk)1133 static void nvme_tcp_state_change(struct sock *sk)
1134 {
1135 	struct nvme_tcp_queue *queue;
1136 
1137 	read_lock_bh(&sk->sk_callback_lock);
1138 	queue = sk->sk_user_data;
1139 	if (!queue)
1140 		goto done;
1141 
1142 	switch (sk->sk_state) {
1143 	case TCP_CLOSE:
1144 	case TCP_CLOSE_WAIT:
1145 	case TCP_LAST_ACK:
1146 	case TCP_FIN_WAIT1:
1147 	case TCP_FIN_WAIT2:
1148 		nvme_tcp_error_recovery(&queue->ctrl->ctrl);
1149 		break;
1150 	default:
1151 		dev_info(queue->ctrl->ctrl.device,
1152 			"queue %d socket state %d\n",
1153 			nvme_tcp_queue_id(queue), sk->sk_state);
1154 	}
1155 
1156 	queue->state_change(sk);
1157 done:
1158 	read_unlock_bh(&sk->sk_callback_lock);
1159 }
1160 
nvme_tcp_done_send_req(struct nvme_tcp_queue * queue)1161 static inline void nvme_tcp_done_send_req(struct nvme_tcp_queue *queue)
1162 {
1163 	queue->request = NULL;
1164 }
1165 
nvme_tcp_fail_request(struct nvme_tcp_request * req)1166 static void nvme_tcp_fail_request(struct nvme_tcp_request *req)
1167 {
1168 	if (nvme_tcp_async_req(req)) {
1169 		union nvme_result res = {};
1170 
1171 		nvme_complete_async_event(&req->queue->ctrl->ctrl,
1172 				cpu_to_le16(NVME_SC_HOST_PATH_ERROR), &res);
1173 	} else {
1174 		nvme_tcp_end_request(blk_mq_rq_from_pdu(req),
1175 				NVME_SC_HOST_PATH_ERROR);
1176 	}
1177 }
1178 
nvme_tcp_try_send_data(struct nvme_tcp_request * req)1179 static int nvme_tcp_try_send_data(struct nvme_tcp_request *req)
1180 {
1181 	struct nvme_tcp_queue *queue = req->queue;
1182 	int req_data_len = req->data_len;
1183 	u32 h2cdata_left = req->h2cdata_left;
1184 
1185 	while (true) {
1186 		struct bio_vec bvec;
1187 		struct msghdr msg = {
1188 			.msg_flags = MSG_DONTWAIT | MSG_SPLICE_PAGES,
1189 		};
1190 		struct page *page = nvme_tcp_req_cur_page(req);
1191 		size_t offset = nvme_tcp_req_cur_offset(req);
1192 		size_t len = nvme_tcp_req_cur_length(req);
1193 		bool last = nvme_tcp_pdu_last_send(req, len);
1194 		int req_data_sent = req->data_sent;
1195 		int ret;
1196 
1197 		if (last && !queue->data_digest && !nvme_tcp_queue_more(queue))
1198 			msg.msg_flags |= MSG_EOR;
1199 		else
1200 			msg.msg_flags |= MSG_MORE;
1201 
1202 		if (!sendpages_ok(page, len, offset))
1203 			msg.msg_flags &= ~MSG_SPLICE_PAGES;
1204 
1205 		bvec_set_page(&bvec, page, len, offset);
1206 		iov_iter_bvec(&msg.msg_iter, ITER_SOURCE, &bvec, 1, len);
1207 		ret = sock_sendmsg(queue->sock, &msg);
1208 		if (ret <= 0)
1209 			return ret;
1210 
1211 		if (queue->data_digest)
1212 			nvme_tcp_ddgst_update(&queue->snd_crc, page,
1213 					offset, ret);
1214 
1215 		/*
1216 		 * update the request iterator except for the last payload send
1217 		 * in the request where we don't want to modify it as we may
1218 		 * compete with the RX path completing the request.
1219 		 */
1220 		if (req_data_sent + ret < req_data_len)
1221 			nvme_tcp_advance_req(req, ret);
1222 
1223 		/* fully successful last send in current PDU */
1224 		if (last && ret == len) {
1225 			if (queue->data_digest) {
1226 				req->ddgst =
1227 					nvme_tcp_ddgst_final(queue->snd_crc);
1228 				req->state = NVME_TCP_SEND_DDGST;
1229 				req->offset = 0;
1230 			} else {
1231 				if (h2cdata_left)
1232 					nvme_tcp_setup_h2c_data_pdu(req);
1233 				else
1234 					nvme_tcp_done_send_req(queue);
1235 			}
1236 			return 1;
1237 		}
1238 	}
1239 	return -EAGAIN;
1240 }
1241 
nvme_tcp_try_send_cmd_pdu(struct nvme_tcp_request * req)1242 static int nvme_tcp_try_send_cmd_pdu(struct nvme_tcp_request *req)
1243 {
1244 	struct nvme_tcp_queue *queue = req->queue;
1245 	struct nvme_tcp_cmd_pdu *pdu = nvme_tcp_req_cmd_pdu(req);
1246 	struct bio_vec bvec;
1247 	struct msghdr msg = { .msg_flags = MSG_DONTWAIT | MSG_SPLICE_PAGES, };
1248 	bool inline_data = nvme_tcp_has_inline_data(req);
1249 	u8 hdgst = nvme_tcp_hdgst_len(queue);
1250 	int len = sizeof(*pdu) + hdgst - req->offset;
1251 	int ret;
1252 
1253 	if (inline_data || nvme_tcp_queue_more(queue))
1254 		msg.msg_flags |= MSG_MORE;
1255 	else
1256 		msg.msg_flags |= MSG_EOR;
1257 
1258 	if (queue->hdr_digest && !req->offset)
1259 		nvme_tcp_set_hdgst(pdu, sizeof(*pdu));
1260 
1261 	bvec_set_virt(&bvec, (void *)pdu + req->offset, len);
1262 	iov_iter_bvec(&msg.msg_iter, ITER_SOURCE, &bvec, 1, len);
1263 	ret = sock_sendmsg(queue->sock, &msg);
1264 	if (unlikely(ret <= 0))
1265 		return ret;
1266 
1267 	len -= ret;
1268 	if (!len) {
1269 		if (inline_data) {
1270 			req->state = NVME_TCP_SEND_DATA;
1271 			if (queue->data_digest)
1272 				queue->snd_crc = NVME_TCP_CRC_SEED;
1273 		} else {
1274 			nvme_tcp_done_send_req(queue);
1275 		}
1276 		return 1;
1277 	}
1278 	req->offset += ret;
1279 
1280 	return -EAGAIN;
1281 }
1282 
nvme_tcp_try_send_data_pdu(struct nvme_tcp_request * req)1283 static int nvme_tcp_try_send_data_pdu(struct nvme_tcp_request *req)
1284 {
1285 	struct nvme_tcp_queue *queue = req->queue;
1286 	struct nvme_tcp_data_pdu *pdu = nvme_tcp_req_data_pdu(req);
1287 	struct bio_vec bvec;
1288 	struct msghdr msg = { .msg_flags = MSG_DONTWAIT | MSG_MORE, };
1289 	u8 hdgst = nvme_tcp_hdgst_len(queue);
1290 	int len = sizeof(*pdu) - req->offset + hdgst;
1291 	int ret;
1292 
1293 	if (queue->hdr_digest && !req->offset)
1294 		nvme_tcp_set_hdgst(pdu, sizeof(*pdu));
1295 
1296 	if (!req->h2cdata_left)
1297 		msg.msg_flags |= MSG_SPLICE_PAGES;
1298 
1299 	bvec_set_virt(&bvec, (void *)pdu + req->offset, len);
1300 	iov_iter_bvec(&msg.msg_iter, ITER_SOURCE, &bvec, 1, len);
1301 	ret = sock_sendmsg(queue->sock, &msg);
1302 	if (unlikely(ret <= 0))
1303 		return ret;
1304 
1305 	len -= ret;
1306 	if (!len) {
1307 		req->state = NVME_TCP_SEND_DATA;
1308 		if (queue->data_digest)
1309 			queue->snd_crc = NVME_TCP_CRC_SEED;
1310 		return 1;
1311 	}
1312 	req->offset += ret;
1313 
1314 	return -EAGAIN;
1315 }
1316 
nvme_tcp_try_send_ddgst(struct nvme_tcp_request * req)1317 static int nvme_tcp_try_send_ddgst(struct nvme_tcp_request *req)
1318 {
1319 	struct nvme_tcp_queue *queue = req->queue;
1320 	size_t offset = req->offset;
1321 	u32 h2cdata_left = req->h2cdata_left;
1322 	int ret;
1323 	struct msghdr msg = { .msg_flags = MSG_DONTWAIT };
1324 	struct kvec iov = {
1325 		.iov_base = (u8 *)&req->ddgst + req->offset,
1326 		.iov_len = NVME_TCP_DIGEST_LENGTH - req->offset
1327 	};
1328 
1329 	if (nvme_tcp_queue_more(queue))
1330 		msg.msg_flags |= MSG_MORE;
1331 	else
1332 		msg.msg_flags |= MSG_EOR;
1333 
1334 	ret = kernel_sendmsg(queue->sock, &msg, &iov, 1, iov.iov_len);
1335 	if (unlikely(ret <= 0))
1336 		return ret;
1337 
1338 	if (offset + ret == NVME_TCP_DIGEST_LENGTH) {
1339 		if (h2cdata_left)
1340 			nvme_tcp_setup_h2c_data_pdu(req);
1341 		else
1342 			nvme_tcp_done_send_req(queue);
1343 		return 1;
1344 	}
1345 
1346 	req->offset += ret;
1347 	return -EAGAIN;
1348 }
1349 
nvme_tcp_try_send(struct nvme_tcp_queue * queue)1350 static int nvme_tcp_try_send(struct nvme_tcp_queue *queue)
1351 {
1352 	struct nvme_tcp_request *req;
1353 	unsigned int noreclaim_flag;
1354 	int ret = 1;
1355 
1356 	if (!queue->request) {
1357 		queue->request = nvme_tcp_fetch_request(queue);
1358 		if (!queue->request)
1359 			return 0;
1360 	}
1361 	req = queue->request;
1362 
1363 	noreclaim_flag = memalloc_noreclaim_save();
1364 	if (req->state == NVME_TCP_SEND_CMD_PDU) {
1365 		ret = nvme_tcp_try_send_cmd_pdu(req);
1366 		if (ret <= 0)
1367 			goto done;
1368 		if (!nvme_tcp_has_inline_data(req))
1369 			goto out;
1370 	}
1371 
1372 	if (req->state == NVME_TCP_SEND_H2C_PDU) {
1373 		ret = nvme_tcp_try_send_data_pdu(req);
1374 		if (ret <= 0)
1375 			goto done;
1376 	}
1377 
1378 	if (req->state == NVME_TCP_SEND_DATA) {
1379 		ret = nvme_tcp_try_send_data(req);
1380 		if (ret <= 0)
1381 			goto done;
1382 	}
1383 
1384 	if (req->state == NVME_TCP_SEND_DDGST)
1385 		ret = nvme_tcp_try_send_ddgst(req);
1386 done:
1387 	if (ret == -EAGAIN) {
1388 		ret = 0;
1389 	} else if (ret < 0) {
1390 		dev_err(queue->ctrl->ctrl.device,
1391 			"failed to send request %d\n", ret);
1392 		nvme_tcp_fail_request(queue->request);
1393 		nvme_tcp_done_send_req(queue);
1394 	}
1395 out:
1396 	memalloc_noreclaim_restore(noreclaim_flag);
1397 	return ret;
1398 }
1399 
nvme_tcp_try_recv(struct nvme_tcp_queue * queue)1400 static int nvme_tcp_try_recv(struct nvme_tcp_queue *queue)
1401 {
1402 	struct socket *sock = queue->sock;
1403 	struct sock *sk = sock->sk;
1404 	read_descriptor_t rd_desc;
1405 	int consumed;
1406 
1407 	rd_desc.arg.data = queue;
1408 	rd_desc.count = 1;
1409 	lock_sock(sk);
1410 	queue->nr_cqe = 0;
1411 	consumed = sock->ops->read_sock(sk, &rd_desc, nvme_tcp_recv_skb);
1412 	release_sock(sk);
1413 	return consumed == -EAGAIN ? 0 : consumed;
1414 }
1415 
nvme_tcp_io_work(struct work_struct * w)1416 static void nvme_tcp_io_work(struct work_struct *w)
1417 {
1418 	struct nvme_tcp_queue *queue =
1419 		container_of(w, struct nvme_tcp_queue, io_work);
1420 	unsigned long deadline = jiffies + msecs_to_jiffies(1);
1421 
1422 	do {
1423 		bool pending = false;
1424 		int result;
1425 
1426 		if (mutex_trylock(&queue->send_mutex)) {
1427 			result = nvme_tcp_try_send(queue);
1428 			mutex_unlock(&queue->send_mutex);
1429 			if (result > 0)
1430 				pending = true;
1431 			else if (unlikely(result < 0))
1432 				break;
1433 		}
1434 
1435 		result = nvme_tcp_try_recv(queue);
1436 		if (result > 0)
1437 			pending = true;
1438 		else if (unlikely(result < 0))
1439 			return;
1440 
1441 		/* did we get some space after spending time in recv? */
1442 		if (nvme_tcp_queue_has_pending(queue) &&
1443 		    sk_stream_is_writeable(queue->sock->sk))
1444 			pending = true;
1445 
1446 		if (!pending || !queue->rd_enabled)
1447 			return;
1448 
1449 	} while (!time_after(jiffies, deadline)); /* quota is exhausted */
1450 
1451 	queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
1452 }
1453 
nvme_tcp_free_async_req(struct nvme_tcp_ctrl * ctrl)1454 static void nvme_tcp_free_async_req(struct nvme_tcp_ctrl *ctrl)
1455 {
1456 	struct nvme_tcp_request *async = &ctrl->async_req;
1457 
1458 	page_frag_free(async->pdu);
1459 }
1460 
nvme_tcp_alloc_async_req(struct nvme_tcp_ctrl * ctrl)1461 static int nvme_tcp_alloc_async_req(struct nvme_tcp_ctrl *ctrl)
1462 {
1463 	struct nvme_tcp_queue *queue = &ctrl->queues[0];
1464 	struct nvme_tcp_request *async = &ctrl->async_req;
1465 	u8 hdgst = nvme_tcp_hdgst_len(queue);
1466 
1467 	mutex_lock(&queue->pf_cache_lock);
1468 	async->pdu = page_frag_alloc(&queue->pf_cache,
1469 		sizeof(struct nvme_tcp_cmd_pdu) + hdgst,
1470 		GFP_KERNEL | __GFP_ZERO);
1471 	mutex_unlock(&queue->pf_cache_lock);
1472 	if (!async->pdu)
1473 		return -ENOMEM;
1474 
1475 	async->queue = &ctrl->queues[0];
1476 	return 0;
1477 }
1478 
nvme_tcp_free_queue(struct nvme_ctrl * nctrl,int qid)1479 static void nvme_tcp_free_queue(struct nvme_ctrl *nctrl, int qid)
1480 {
1481 	struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1482 	struct nvme_tcp_queue *queue = &ctrl->queues[qid];
1483 	unsigned int noio_flag;
1484 
1485 	if (!test_and_clear_bit(NVME_TCP_Q_ALLOCATED, &queue->flags))
1486 		return;
1487 
1488 	page_frag_cache_drain(&queue->pf_cache);
1489 
1490 	/**
1491 	 * Prevent memory reclaim from triggering block I/O during socket
1492 	 * teardown. The socket release path fput -> tcp_close ->
1493 	 * tcp_disconnect -> tcp_send_active_reset may allocate memory, and
1494 	 * allowing reclaim to issue I/O could deadlock if we're being called
1495 	 * from block device teardown (e.g., del_gendisk -> elevator cleanup)
1496 	 * which holds locks that the I/O completion path needs.
1497 	 */
1498 	noio_flag = memalloc_noio_save();
1499 
1500 	/**
1501 	 * Release the socket synchronously. During reset in
1502 	 * nvme_reset_ctrl_work(), queue teardown is immediately followed by
1503 	 * re-allocation. fput() defers socket cleanup to delayed_fput_work
1504 	 * in workqueue context, which can race with new queue setup.
1505 	 */
1506 	__fput_sync(queue->sock->file);
1507 	queue->sock = NULL;
1508 	memalloc_noio_restore(noio_flag);
1509 
1510 	kfree(queue->pdu);
1511 	mutex_destroy(&queue->send_mutex);
1512 	mutex_destroy(&queue->queue_lock);
1513 	mutex_destroy(&queue->pf_cache_lock);
1514 
1515 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1516 	lockdep_unregister_key(&queue->nvme_tcp_sk_key);
1517 	lockdep_unregister_key(&queue->nvme_tcp_slock_key);
1518 #endif
1519 }
1520 
nvme_tcp_init_connection(struct nvme_tcp_queue * queue)1521 static int nvme_tcp_init_connection(struct nvme_tcp_queue *queue)
1522 {
1523 	struct nvme_tcp_icreq_pdu *icreq;
1524 	struct nvme_tcp_icresp_pdu *icresp;
1525 	char cbuf[CMSG_LEN(sizeof(char))] = {};
1526 	u8 ctype;
1527 	struct msghdr msg = {};
1528 	struct kvec iov;
1529 	bool ctrl_hdgst, ctrl_ddgst;
1530 	u32 maxh2cdata;
1531 	int ret;
1532 
1533 	icreq = kzalloc_obj(*icreq);
1534 	if (!icreq)
1535 		return -ENOMEM;
1536 
1537 	icresp = kzalloc_obj(*icresp);
1538 	if (!icresp) {
1539 		ret = -ENOMEM;
1540 		goto free_icreq;
1541 	}
1542 
1543 	icreq->hdr.type = nvme_tcp_icreq;
1544 	icreq->hdr.hlen = sizeof(*icreq);
1545 	icreq->hdr.pdo = 0;
1546 	icreq->hdr.plen = cpu_to_le32(icreq->hdr.hlen);
1547 	icreq->pfv = cpu_to_le16(NVME_TCP_PFV_1_0);
1548 	icreq->maxr2t = 0; /* single inflight r2t supported */
1549 	icreq->hpda = 0; /* no alignment constraint */
1550 	if (queue->hdr_digest)
1551 		icreq->digest |= NVME_TCP_HDR_DIGEST_ENABLE;
1552 	if (queue->data_digest)
1553 		icreq->digest |= NVME_TCP_DATA_DIGEST_ENABLE;
1554 
1555 	iov.iov_base = icreq;
1556 	iov.iov_len = sizeof(*icreq);
1557 	ret = kernel_sendmsg(queue->sock, &msg, &iov, 1, iov.iov_len);
1558 	if (ret < 0) {
1559 		pr_warn("queue %d: failed to send icreq, error %d\n",
1560 			nvme_tcp_queue_id(queue), ret);
1561 		goto free_icresp;
1562 	}
1563 
1564 	memset(&msg, 0, sizeof(msg));
1565 	iov.iov_base = icresp;
1566 	iov.iov_len = sizeof(*icresp);
1567 	if (nvme_tcp_queue_tls(queue)) {
1568 		msg.msg_control = cbuf;
1569 		msg.msg_controllen = sizeof(cbuf);
1570 	}
1571 	msg.msg_flags = MSG_WAITALL;
1572 	ret = kernel_recvmsg(queue->sock, &msg, &iov, 1,
1573 			iov.iov_len, msg.msg_flags);
1574 	if (ret >= 0 && ret < sizeof(*icresp))
1575 		ret = -ECONNRESET;
1576 	if (ret < 0) {
1577 		pr_warn("queue %d: failed to receive icresp, error %d\n",
1578 			nvme_tcp_queue_id(queue), ret);
1579 		goto free_icresp;
1580 	}
1581 	ret = -ENOTCONN;
1582 	if (nvme_tcp_queue_tls(queue)) {
1583 		ctype = tls_get_record_type(queue->sock->sk,
1584 					    (struct cmsghdr *)cbuf);
1585 		if (ctype != TLS_RECORD_TYPE_DATA) {
1586 			pr_err("queue %d: unhandled TLS record %d\n",
1587 			       nvme_tcp_queue_id(queue), ctype);
1588 			goto free_icresp;
1589 		}
1590 	}
1591 	ret = -EINVAL;
1592 	if (icresp->hdr.type != nvme_tcp_icresp) {
1593 		pr_err("queue %d: bad type returned %d\n",
1594 			nvme_tcp_queue_id(queue), icresp->hdr.type);
1595 		goto free_icresp;
1596 	}
1597 
1598 	if (le32_to_cpu(icresp->hdr.plen) != sizeof(*icresp)) {
1599 		pr_err("queue %d: bad pdu length returned %d\n",
1600 			nvme_tcp_queue_id(queue), icresp->hdr.plen);
1601 		goto free_icresp;
1602 	}
1603 
1604 	if (icresp->pfv != NVME_TCP_PFV_1_0) {
1605 		pr_err("queue %d: bad pfv returned %d\n",
1606 			nvme_tcp_queue_id(queue), icresp->pfv);
1607 		goto free_icresp;
1608 	}
1609 
1610 	ctrl_ddgst = !!(icresp->digest & NVME_TCP_DATA_DIGEST_ENABLE);
1611 	if ((queue->data_digest && !ctrl_ddgst) ||
1612 	    (!queue->data_digest && ctrl_ddgst)) {
1613 		pr_err("queue %d: data digest mismatch host: %s ctrl: %s\n",
1614 			nvme_tcp_queue_id(queue),
1615 			queue->data_digest ? "enabled" : "disabled",
1616 			ctrl_ddgst ? "enabled" : "disabled");
1617 		goto free_icresp;
1618 	}
1619 
1620 	ctrl_hdgst = !!(icresp->digest & NVME_TCP_HDR_DIGEST_ENABLE);
1621 	if ((queue->hdr_digest && !ctrl_hdgst) ||
1622 	    (!queue->hdr_digest && ctrl_hdgst)) {
1623 		pr_err("queue %d: header digest mismatch host: %s ctrl: %s\n",
1624 			nvme_tcp_queue_id(queue),
1625 			queue->hdr_digest ? "enabled" : "disabled",
1626 			ctrl_hdgst ? "enabled" : "disabled");
1627 		goto free_icresp;
1628 	}
1629 
1630 	if (icresp->cpda != 0) {
1631 		pr_err("queue %d: unsupported cpda returned %d\n",
1632 			nvme_tcp_queue_id(queue), icresp->cpda);
1633 		goto free_icresp;
1634 	}
1635 
1636 	maxh2cdata = le32_to_cpu(icresp->maxdata);
1637 	if ((maxh2cdata % 4) || (maxh2cdata < NVME_TCP_MIN_MAXH2CDATA)) {
1638 		pr_err("queue %d: invalid maxh2cdata returned %u\n",
1639 		       nvme_tcp_queue_id(queue), maxh2cdata);
1640 		goto free_icresp;
1641 	}
1642 	queue->maxh2cdata = maxh2cdata;
1643 
1644 	ret = 0;
1645 free_icresp:
1646 	kfree(icresp);
1647 free_icreq:
1648 	kfree(icreq);
1649 	return ret;
1650 }
1651 
nvme_tcp_admin_queue(struct nvme_tcp_queue * queue)1652 static bool nvme_tcp_admin_queue(struct nvme_tcp_queue *queue)
1653 {
1654 	return nvme_tcp_queue_id(queue) == 0;
1655 }
1656 
nvme_tcp_default_queue(struct nvme_tcp_queue * queue)1657 static bool nvme_tcp_default_queue(struct nvme_tcp_queue *queue)
1658 {
1659 	struct nvme_tcp_ctrl *ctrl = queue->ctrl;
1660 	int qid = nvme_tcp_queue_id(queue);
1661 
1662 	return !nvme_tcp_admin_queue(queue) &&
1663 		qid < 1 + ctrl->io_queues[HCTX_TYPE_DEFAULT];
1664 }
1665 
nvme_tcp_read_queue(struct nvme_tcp_queue * queue)1666 static bool nvme_tcp_read_queue(struct nvme_tcp_queue *queue)
1667 {
1668 	struct nvme_tcp_ctrl *ctrl = queue->ctrl;
1669 	int qid = nvme_tcp_queue_id(queue);
1670 
1671 	return !nvme_tcp_admin_queue(queue) &&
1672 		!nvme_tcp_default_queue(queue) &&
1673 		qid < 1 + ctrl->io_queues[HCTX_TYPE_DEFAULT] +
1674 			  ctrl->io_queues[HCTX_TYPE_READ];
1675 }
1676 
nvme_tcp_poll_queue(struct nvme_tcp_queue * queue)1677 static bool nvme_tcp_poll_queue(struct nvme_tcp_queue *queue)
1678 {
1679 	struct nvme_tcp_ctrl *ctrl = queue->ctrl;
1680 	int qid = nvme_tcp_queue_id(queue);
1681 
1682 	return !nvme_tcp_admin_queue(queue) &&
1683 		!nvme_tcp_default_queue(queue) &&
1684 		!nvme_tcp_read_queue(queue) &&
1685 		qid < 1 + ctrl->io_queues[HCTX_TYPE_DEFAULT] +
1686 			  ctrl->io_queues[HCTX_TYPE_READ] +
1687 			  ctrl->io_queues[HCTX_TYPE_POLL];
1688 }
1689 
1690 /*
1691  * Track the number of queues assigned to each cpu using a global per-cpu
1692  * counter and select the least used cpu from the mq_map. Our goal is to spread
1693  * different controllers I/O threads across different cpu cores.
1694  *
1695  * Note that the accounting is not 100% perfect, but we don't need to be, we're
1696  * simply putting our best effort to select the best candidate cpu core that we
1697  * find at any given point.
1698  */
nvme_tcp_set_queue_io_cpu(struct nvme_tcp_queue * queue)1699 static void nvme_tcp_set_queue_io_cpu(struct nvme_tcp_queue *queue)
1700 {
1701 	struct nvme_tcp_ctrl *ctrl = queue->ctrl;
1702 	struct blk_mq_tag_set *set = &ctrl->tag_set;
1703 	int qid = nvme_tcp_queue_id(queue) - 1;
1704 	unsigned int *mq_map = NULL;
1705 	int cpu, min_queues = INT_MAX, io_cpu;
1706 
1707 	if (wq_unbound)
1708 		goto out;
1709 
1710 	if (nvme_tcp_default_queue(queue))
1711 		mq_map = set->map[HCTX_TYPE_DEFAULT].mq_map;
1712 	else if (nvme_tcp_read_queue(queue))
1713 		mq_map = set->map[HCTX_TYPE_READ].mq_map;
1714 	else if (nvme_tcp_poll_queue(queue))
1715 		mq_map = set->map[HCTX_TYPE_POLL].mq_map;
1716 
1717 	if (WARN_ON(!mq_map))
1718 		goto out;
1719 
1720 	/* Search for the least used cpu from the mq_map */
1721 	io_cpu = WORK_CPU_UNBOUND;
1722 	for_each_online_cpu(cpu) {
1723 		int num_queues = atomic_read(&nvme_tcp_cpu_queues[cpu]);
1724 
1725 		if (mq_map[cpu] != qid)
1726 			continue;
1727 		if (num_queues < min_queues) {
1728 			io_cpu = cpu;
1729 			min_queues = num_queues;
1730 		}
1731 	}
1732 	if (io_cpu != WORK_CPU_UNBOUND) {
1733 		queue->io_cpu = io_cpu;
1734 		atomic_inc(&nvme_tcp_cpu_queues[io_cpu]);
1735 		set_bit(NVME_TCP_Q_IO_CPU_SET, &queue->flags);
1736 	}
1737 out:
1738 	dev_dbg(ctrl->ctrl.device, "queue %d: using cpu %d\n",
1739 		qid, queue->io_cpu);
1740 }
1741 
nvme_tcp_tls_done(void * data,int status,key_serial_t pskid)1742 static void nvme_tcp_tls_done(void *data, int status, key_serial_t pskid)
1743 {
1744 	struct nvme_tcp_queue *queue = data;
1745 	struct nvme_tcp_ctrl *ctrl = queue->ctrl;
1746 	int qid = nvme_tcp_queue_id(queue);
1747 	struct key *tls_key;
1748 
1749 	dev_dbg(ctrl->ctrl.device, "queue %d: TLS handshake done, key %x, status %d\n",
1750 		qid, pskid, status);
1751 
1752 	if (status) {
1753 		queue->tls_err = status;
1754 		goto out_complete;
1755 	}
1756 
1757 	tls_key = nvme_tls_key_lookup(pskid);
1758 	if (IS_ERR(tls_key)) {
1759 		dev_warn(ctrl->ctrl.device, "queue %d: Invalid key %x\n",
1760 			 qid, pskid);
1761 		queue->tls_err = -ENOKEY;
1762 	} else {
1763 		queue->tls_enabled = true;
1764 		if (qid == 0)
1765 			ctrl->ctrl.tls_pskid = key_serial(tls_key);
1766 		key_put(tls_key);
1767 		queue->tls_err = 0;
1768 	}
1769 
1770 out_complete:
1771 	complete(&queue->tls_complete);
1772 }
1773 
nvme_tcp_start_tls(struct nvme_ctrl * nctrl,struct nvme_tcp_queue * queue,key_serial_t pskid)1774 static int nvme_tcp_start_tls(struct nvme_ctrl *nctrl,
1775 			      struct nvme_tcp_queue *queue,
1776 			      key_serial_t pskid)
1777 {
1778 	int qid = nvme_tcp_queue_id(queue);
1779 	int ret;
1780 	struct tls_handshake_args args;
1781 	unsigned long tmo = tls_handshake_timeout * HZ;
1782 	key_serial_t keyring = nvme_keyring_id();
1783 
1784 	dev_dbg(nctrl->device, "queue %d: start TLS with key %x\n",
1785 		qid, pskid);
1786 	memset(&args, 0, sizeof(args));
1787 	args.ta_sock = queue->sock;
1788 	args.ta_done = nvme_tcp_tls_done;
1789 	args.ta_data = queue;
1790 	args.ta_my_peerids[0] = pskid;
1791 	args.ta_num_peerids = 1;
1792 	if (nctrl->opts->keyring)
1793 		keyring = key_serial(nctrl->opts->keyring);
1794 	args.ta_keyring = keyring;
1795 	args.ta_timeout_ms = tls_handshake_timeout * 1000;
1796 	queue->tls_err = -EOPNOTSUPP;
1797 	init_completion(&queue->tls_complete);
1798 	ret = tls_client_hello_psk(&args, GFP_KERNEL);
1799 	if (ret) {
1800 		dev_err(nctrl->device, "queue %d: failed to start TLS: %d\n",
1801 			qid, ret);
1802 		return ret;
1803 	}
1804 	ret = wait_for_completion_interruptible_timeout(&queue->tls_complete, tmo);
1805 	if (ret <= 0) {
1806 		if (ret == 0)
1807 			ret = -ETIMEDOUT;
1808 
1809 		dev_err(nctrl->device,
1810 			"queue %d: TLS handshake failed, error %d\n",
1811 			qid, ret);
1812 		tls_handshake_cancel(queue->sock->sk);
1813 	} else {
1814 		if (queue->tls_err) {
1815 			dev_err(nctrl->device,
1816 				"queue %d: TLS handshake complete, error %d\n",
1817 				qid, queue->tls_err);
1818 		} else {
1819 			dev_dbg(nctrl->device,
1820 				"queue %d: TLS handshake complete\n", qid);
1821 		}
1822 		ret = queue->tls_err;
1823 	}
1824 	return ret;
1825 }
1826 
nvme_tcp_alloc_queue(struct nvme_ctrl * nctrl,int qid,key_serial_t pskid)1827 static int nvme_tcp_alloc_queue(struct nvme_ctrl *nctrl, int qid,
1828 				key_serial_t pskid)
1829 {
1830 	struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
1831 	struct nvme_tcp_queue *queue = &ctrl->queues[qid];
1832 	int ret, rcv_pdu_size;
1833 	struct file *sock_file;
1834 
1835 	mutex_init(&queue->queue_lock);
1836 	queue->ctrl = ctrl;
1837 	init_llist_head(&queue->req_list);
1838 	INIT_LIST_HEAD(&queue->send_list);
1839 	mutex_init(&queue->send_mutex);
1840 	INIT_WORK(&queue->io_work, nvme_tcp_io_work);
1841 	mutex_init(&queue->pf_cache_lock);
1842 
1843 	if (qid > 0)
1844 		queue->cmnd_capsule_len = nctrl->ioccsz * 16;
1845 	else
1846 		queue->cmnd_capsule_len = sizeof(struct nvme_command) +
1847 						NVME_TCP_ADMIN_CCSZ;
1848 
1849 	ret = sock_create_kern(current->nsproxy->net_ns,
1850 			ctrl->addr.ss_family, SOCK_STREAM,
1851 			IPPROTO_TCP, &queue->sock);
1852 	if (ret) {
1853 		dev_err(nctrl->device,
1854 			"failed to create socket: %d\n", ret);
1855 		goto err_destroy_mutex;
1856 	}
1857 
1858 	sock_file = sock_alloc_file(queue->sock, O_CLOEXEC, NULL);
1859 	if (IS_ERR(sock_file)) {
1860 		ret = PTR_ERR(sock_file);
1861 		goto err_destroy_mutex;
1862 	}
1863 
1864 	sk_net_refcnt_upgrade(queue->sock->sk);
1865 
1866 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1867 	lockdep_register_key(&queue->nvme_tcp_sk_key);
1868 	lockdep_register_key(&queue->nvme_tcp_slock_key);
1869 	nvme_tcp_reclassify_socket(queue);
1870 #endif
1871 
1872 	/* Single syn retry */
1873 	tcp_sock_set_syncnt(queue->sock->sk, 1);
1874 
1875 	/* Set TCP no delay */
1876 	tcp_sock_set_nodelay(queue->sock->sk);
1877 
1878 	/*
1879 	 * Cleanup whatever is sitting in the TCP transmit queue on socket
1880 	 * close. This is done to prevent stale data from being sent should
1881 	 * the network connection be restored before TCP times out.
1882 	 */
1883 	sock_no_linger(queue->sock->sk);
1884 
1885 	if (so_priority > 0)
1886 		sock_set_priority(queue->sock->sk, so_priority);
1887 
1888 	/* Set socket type of service */
1889 	if (nctrl->opts->tos >= 0)
1890 		ip_sock_set_tos(queue->sock->sk, nctrl->opts->tos);
1891 
1892 	/* Set 10 seconds timeout for icresp recvmsg */
1893 	queue->sock->sk->sk_rcvtimeo = 10 * HZ;
1894 
1895 	queue->sock->sk->sk_allocation = GFP_ATOMIC;
1896 	queue->sock->sk->sk_use_task_frag = false;
1897 	queue->io_cpu = WORK_CPU_UNBOUND;
1898 	queue->request = NULL;
1899 	queue->data_remaining = 0;
1900 	queue->ddgst_remaining = 0;
1901 	queue->pdu_remaining = 0;
1902 	queue->pdu_offset = 0;
1903 	sk_set_memalloc(queue->sock->sk);
1904 
1905 	if (nctrl->opts->mask & NVMF_OPT_HOST_TRADDR) {
1906 		ret = kernel_bind(queue->sock, (struct sockaddr_unsized *)&ctrl->src_addr,
1907 			sizeof(ctrl->src_addr));
1908 		if (ret) {
1909 			dev_err(nctrl->device,
1910 				"failed to bind queue %d socket %d\n",
1911 				qid, ret);
1912 			goto err_sock;
1913 		}
1914 	}
1915 
1916 	if (nctrl->opts->mask & NVMF_OPT_HOST_IFACE) {
1917 		char *iface = nctrl->opts->host_iface;
1918 		sockptr_t optval = KERNEL_SOCKPTR(iface);
1919 
1920 		ret = sock_setsockopt(queue->sock, SOL_SOCKET, SO_BINDTODEVICE,
1921 				      optval, strlen(iface));
1922 		if (ret) {
1923 			dev_err(nctrl->device,
1924 			  "failed to bind to interface %s queue %d err %d\n",
1925 			  iface, qid, ret);
1926 			goto err_sock;
1927 		}
1928 	}
1929 
1930 	queue->hdr_digest = nctrl->opts->hdr_digest;
1931 	queue->data_digest = nctrl->opts->data_digest;
1932 
1933 	rcv_pdu_size = sizeof(struct nvme_tcp_rsp_pdu) +
1934 			nvme_tcp_hdgst_len(queue);
1935 	queue->pdu = kmalloc(rcv_pdu_size, GFP_KERNEL);
1936 	if (!queue->pdu) {
1937 		ret = -ENOMEM;
1938 		goto err_sock;
1939 	}
1940 
1941 	dev_dbg(nctrl->device, "connecting queue %d\n",
1942 			nvme_tcp_queue_id(queue));
1943 
1944 	ret = kernel_connect(queue->sock, (struct sockaddr_unsized *)&ctrl->addr,
1945 		sizeof(ctrl->addr), 0);
1946 	if (ret) {
1947 		dev_err(nctrl->device,
1948 			"failed to connect socket: %d\n", ret);
1949 		goto err_rcv_pdu;
1950 	}
1951 
1952 	/* If PSKs are configured try to start TLS */
1953 	if (nvme_tcp_tls_configured(nctrl) && pskid) {
1954 		ret = nvme_tcp_start_tls(nctrl, queue, pskid);
1955 		if (ret)
1956 			goto err_init_connect;
1957 	}
1958 
1959 	ret = nvme_tcp_init_connection(queue);
1960 	if (ret)
1961 		goto err_init_connect;
1962 
1963 	set_bit(NVME_TCP_Q_ALLOCATED, &queue->flags);
1964 
1965 	return 0;
1966 
1967 err_init_connect:
1968 	kernel_sock_shutdown(queue->sock, SHUT_RDWR);
1969 err_rcv_pdu:
1970 	kfree(queue->pdu);
1971 err_sock:
1972 	/* Use sync variant - see nvme_tcp_free_queue() for explanation */
1973 	__fput_sync(queue->sock->file);
1974 	queue->sock = NULL;
1975 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1976 	lockdep_unregister_key(&queue->nvme_tcp_sk_key);
1977 	lockdep_unregister_key(&queue->nvme_tcp_slock_key);
1978 #endif
1979 err_destroy_mutex:
1980 	mutex_destroy(&queue->send_mutex);
1981 	mutex_destroy(&queue->queue_lock);
1982 	mutex_destroy(&queue->pf_cache_lock);
1983 	return ret;
1984 }
1985 
nvme_tcp_restore_sock_ops(struct nvme_tcp_queue * queue)1986 static void nvme_tcp_restore_sock_ops(struct nvme_tcp_queue *queue)
1987 {
1988 	struct socket *sock = queue->sock;
1989 
1990 	write_lock_bh(&sock->sk->sk_callback_lock);
1991 	sock->sk->sk_user_data  = NULL;
1992 	sock->sk->sk_data_ready = queue->data_ready;
1993 	sock->sk->sk_state_change = queue->state_change;
1994 	sock->sk->sk_write_space  = queue->write_space;
1995 	write_unlock_bh(&sock->sk->sk_callback_lock);
1996 }
1997 
__nvme_tcp_stop_queue(struct nvme_tcp_queue * queue)1998 static void __nvme_tcp_stop_queue(struct nvme_tcp_queue *queue)
1999 {
2000 	kernel_sock_shutdown(queue->sock, SHUT_RDWR);
2001 	nvme_tcp_restore_sock_ops(queue);
2002 	cancel_work_sync(&queue->io_work);
2003 }
2004 
nvme_tcp_stop_queue_nowait(struct nvme_ctrl * nctrl,int qid)2005 static void nvme_tcp_stop_queue_nowait(struct nvme_ctrl *nctrl, int qid)
2006 {
2007 	struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
2008 	struct nvme_tcp_queue *queue = &ctrl->queues[qid];
2009 
2010 	if (!test_bit(NVME_TCP_Q_ALLOCATED, &queue->flags))
2011 		return;
2012 
2013 	if (test_and_clear_bit(NVME_TCP_Q_IO_CPU_SET, &queue->flags))
2014 		atomic_dec(&nvme_tcp_cpu_queues[queue->io_cpu]);
2015 
2016 	mutex_lock(&queue->queue_lock);
2017 	if (test_and_clear_bit(NVME_TCP_Q_LIVE, &queue->flags))
2018 		__nvme_tcp_stop_queue(queue);
2019 	/* Stopping the queue will disable TLS */
2020 	queue->tls_enabled = false;
2021 	mutex_unlock(&queue->queue_lock);
2022 }
2023 
nvme_tcp_wait_queue(struct nvme_ctrl * nctrl,int qid)2024 static void nvme_tcp_wait_queue(struct nvme_ctrl *nctrl, int qid)
2025 {
2026 	struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
2027 	struct nvme_tcp_queue *queue = &ctrl->queues[qid];
2028 	int timeout = 100;
2029 
2030 	while (timeout > 0) {
2031 		if (!test_bit(NVME_TCP_Q_ALLOCATED, &queue->flags) ||
2032 		    !sk_wmem_alloc_get(queue->sock->sk))
2033 			return;
2034 		msleep(2);
2035 		timeout -= 2;
2036 	}
2037 	dev_warn(nctrl->device,
2038 		 "qid %d: timeout draining sock wmem allocation expired\n",
2039 		 qid);
2040 }
2041 
nvme_tcp_stop_queue(struct nvme_ctrl * nctrl,int qid)2042 static void nvme_tcp_stop_queue(struct nvme_ctrl *nctrl, int qid)
2043 {
2044 	nvme_tcp_stop_queue_nowait(nctrl, qid);
2045 	nvme_tcp_wait_queue(nctrl, qid);
2046 }
2047 
2048 
nvme_tcp_setup_sock_ops(struct nvme_tcp_queue * queue)2049 static void nvme_tcp_setup_sock_ops(struct nvme_tcp_queue *queue)
2050 {
2051 	write_lock_bh(&queue->sock->sk->sk_callback_lock);
2052 	queue->sock->sk->sk_user_data = queue;
2053 	queue->state_change = queue->sock->sk->sk_state_change;
2054 	queue->data_ready = queue->sock->sk->sk_data_ready;
2055 	queue->write_space = queue->sock->sk->sk_write_space;
2056 	queue->sock->sk->sk_data_ready = nvme_tcp_data_ready;
2057 	queue->sock->sk->sk_state_change = nvme_tcp_state_change;
2058 	queue->sock->sk->sk_write_space = nvme_tcp_write_space;
2059 #ifdef CONFIG_NET_RX_BUSY_POLL
2060 	queue->sock->sk->sk_ll_usec = 1;
2061 #endif
2062 	write_unlock_bh(&queue->sock->sk->sk_callback_lock);
2063 }
2064 
nvme_tcp_start_queue(struct nvme_ctrl * nctrl,int idx)2065 static int nvme_tcp_start_queue(struct nvme_ctrl *nctrl, int idx)
2066 {
2067 	struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
2068 	struct nvme_tcp_queue *queue = &ctrl->queues[idx];
2069 	int ret;
2070 
2071 	queue->rd_enabled = true;
2072 	nvme_tcp_init_recv_ctx(queue);
2073 	nvme_tcp_setup_sock_ops(queue);
2074 
2075 	if (idx) {
2076 		nvme_tcp_set_queue_io_cpu(queue);
2077 		ret = nvmf_connect_io_queue(nctrl, idx);
2078 	} else
2079 		ret = nvmf_connect_admin_queue(nctrl);
2080 
2081 	if (!ret) {
2082 		set_bit(NVME_TCP_Q_LIVE, &queue->flags);
2083 	} else {
2084 		if (test_bit(NVME_TCP_Q_ALLOCATED, &queue->flags))
2085 			__nvme_tcp_stop_queue(queue);
2086 		dev_err(nctrl->device,
2087 			"failed to connect queue: %d ret=%d\n", idx, ret);
2088 	}
2089 	return ret;
2090 }
2091 
nvme_tcp_free_admin_queue(struct nvme_ctrl * ctrl)2092 static void nvme_tcp_free_admin_queue(struct nvme_ctrl *ctrl)
2093 {
2094 	if (to_tcp_ctrl(ctrl)->async_req.pdu) {
2095 		cancel_work_sync(&ctrl->async_event_work);
2096 		nvme_tcp_free_async_req(to_tcp_ctrl(ctrl));
2097 		to_tcp_ctrl(ctrl)->async_req.pdu = NULL;
2098 	}
2099 
2100 	nvme_tcp_free_queue(ctrl, 0);
2101 }
2102 
nvme_tcp_free_io_queues(struct nvme_ctrl * ctrl)2103 static void nvme_tcp_free_io_queues(struct nvme_ctrl *ctrl)
2104 {
2105 	int i;
2106 
2107 	for (i = 1; i < ctrl->queue_count; i++)
2108 		nvme_tcp_free_queue(ctrl, i);
2109 }
2110 
nvme_tcp_stop_io_queues(struct nvme_ctrl * ctrl)2111 static void nvme_tcp_stop_io_queues(struct nvme_ctrl *ctrl)
2112 {
2113 	int i;
2114 
2115 	for (i = 1; i < ctrl->queue_count; i++)
2116 		nvme_tcp_stop_queue_nowait(ctrl, i);
2117 	for (i = 1; i < ctrl->queue_count; i++)
2118 		nvme_tcp_wait_queue(ctrl, i);
2119 }
2120 
nvme_tcp_start_io_queues(struct nvme_ctrl * ctrl,int first,int last)2121 static int nvme_tcp_start_io_queues(struct nvme_ctrl *ctrl,
2122 				    int first, int last)
2123 {
2124 	int i, ret;
2125 
2126 	for (i = first; i < last; i++) {
2127 		ret = nvme_tcp_start_queue(ctrl, i);
2128 		if (ret)
2129 			goto out_stop_queues;
2130 	}
2131 
2132 	return 0;
2133 
2134 out_stop_queues:
2135 	for (i--; i >= first; i--)
2136 		nvme_tcp_stop_queue(ctrl, i);
2137 	return ret;
2138 }
2139 
nvme_tcp_alloc_admin_queue(struct nvme_ctrl * ctrl)2140 static int nvme_tcp_alloc_admin_queue(struct nvme_ctrl *ctrl)
2141 {
2142 	int ret;
2143 	key_serial_t pskid = 0;
2144 
2145 	if (nvme_tcp_tls_configured(ctrl)) {
2146 		if (ctrl->opts->tls_key)
2147 			pskid = key_serial(ctrl->opts->tls_key);
2148 		else if (ctrl->opts->tls) {
2149 			pskid = nvme_tls_psk_default(ctrl->opts->keyring,
2150 						      ctrl->opts->host->nqn,
2151 						      ctrl->opts->subsysnqn);
2152 			if (!pskid) {
2153 				dev_err(ctrl->device, "no valid PSK found\n");
2154 				return -ENOKEY;
2155 			}
2156 		}
2157 	}
2158 
2159 	ret = nvme_tcp_alloc_queue(ctrl, 0, pskid);
2160 	if (ret)
2161 		return ret;
2162 
2163 	ret = nvme_tcp_alloc_async_req(to_tcp_ctrl(ctrl));
2164 	if (ret)
2165 		goto out_free_queue;
2166 
2167 	return 0;
2168 
2169 out_free_queue:
2170 	nvme_tcp_free_queue(ctrl, 0);
2171 	return ret;
2172 }
2173 
__nvme_tcp_alloc_io_queues(struct nvme_ctrl * ctrl)2174 static int __nvme_tcp_alloc_io_queues(struct nvme_ctrl *ctrl)
2175 {
2176 	int i, ret;
2177 
2178 	if (nvme_tcp_tls_configured(ctrl)) {
2179 		if (ctrl->opts->concat) {
2180 			/*
2181 			 * The generated PSK is stored in the
2182 			 * fabric options
2183 			 */
2184 			if (!ctrl->opts->tls_key) {
2185 				dev_err(ctrl->device, "no PSK generated\n");
2186 				return -ENOKEY;
2187 			}
2188 			if (ctrl->tls_pskid &&
2189 			    ctrl->tls_pskid != key_serial(ctrl->opts->tls_key)) {
2190 				dev_err(ctrl->device, "Stale PSK id %08x\n", ctrl->tls_pskid);
2191 				ctrl->tls_pskid = 0;
2192 			}
2193 		} else if (!ctrl->tls_pskid) {
2194 			dev_err(ctrl->device, "no PSK negotiated\n");
2195 			return -ENOKEY;
2196 		}
2197 	}
2198 
2199 	for (i = 1; i < ctrl->queue_count; i++) {
2200 		ret = nvme_tcp_alloc_queue(ctrl, i,
2201 				ctrl->tls_pskid);
2202 		if (ret)
2203 			goto out_free_queues;
2204 	}
2205 
2206 	return 0;
2207 
2208 out_free_queues:
2209 	for (i--; i >= 1; i--)
2210 		nvme_tcp_free_queue(ctrl, i);
2211 
2212 	return ret;
2213 }
2214 
nvme_tcp_alloc_io_queues(struct nvme_ctrl * ctrl)2215 static int nvme_tcp_alloc_io_queues(struct nvme_ctrl *ctrl)
2216 {
2217 	unsigned int nr_io_queues;
2218 	int ret;
2219 
2220 	nr_io_queues = nvmf_nr_io_queues(ctrl->opts);
2221 	ret = nvme_set_queue_count(ctrl, &nr_io_queues);
2222 	if (ret)
2223 		return ret;
2224 
2225 	if (nr_io_queues == 0) {
2226 		dev_err(ctrl->device,
2227 			"unable to set any I/O queues\n");
2228 		return -ENOMEM;
2229 	}
2230 
2231 	ctrl->queue_count = nr_io_queues + 1;
2232 	dev_info(ctrl->device,
2233 		"creating %d I/O queues.\n", nr_io_queues);
2234 
2235 	nvmf_set_io_queues(ctrl->opts, nr_io_queues,
2236 			   to_tcp_ctrl(ctrl)->io_queues);
2237 	return __nvme_tcp_alloc_io_queues(ctrl);
2238 }
2239 
nvme_tcp_configure_io_queues(struct nvme_ctrl * ctrl,bool new)2240 static int nvme_tcp_configure_io_queues(struct nvme_ctrl *ctrl, bool new)
2241 {
2242 	int ret, nr_queues;
2243 
2244 	ret = nvme_tcp_alloc_io_queues(ctrl);
2245 	if (ret)
2246 		return ret;
2247 
2248 	if (new) {
2249 		ret = nvme_alloc_io_tag_set(ctrl, &to_tcp_ctrl(ctrl)->tag_set,
2250 				&nvme_tcp_mq_ops,
2251 				ctrl->opts->nr_poll_queues ? HCTX_MAX_TYPES : 2,
2252 				sizeof(struct nvme_tcp_request));
2253 		if (ret)
2254 			goto out_free_io_queues;
2255 	}
2256 
2257 	/*
2258 	 * Only start IO queues for which we have allocated the tagset
2259 	 * and limited it to the available queues. On reconnects, the
2260 	 * queue number might have changed.
2261 	 */
2262 	nr_queues = min(ctrl->tagset->nr_hw_queues + 1, ctrl->queue_count);
2263 	ret = nvme_tcp_start_io_queues(ctrl, 1, nr_queues);
2264 	if (ret)
2265 		goto out_cleanup_connect_q;
2266 
2267 	if (!new) {
2268 		nvme_start_freeze(ctrl);
2269 		nvme_unquiesce_io_queues(ctrl);
2270 		if (!nvme_wait_freeze_timeout(ctrl)) {
2271 			/*
2272 			 * If we timed out waiting for freeze we are likely to
2273 			 * be stuck.  Fail the controller initialization just
2274 			 * to be safe.
2275 			 */
2276 			ret = -ENODEV;
2277 			nvme_unfreeze(ctrl);
2278 			goto out_wait_freeze_timed_out;
2279 		}
2280 		blk_mq_update_nr_hw_queues(ctrl->tagset,
2281 			ctrl->queue_count - 1);
2282 		nvme_unfreeze(ctrl);
2283 	}
2284 
2285 	/*
2286 	 * If the number of queues has increased (reconnect case)
2287 	 * start all new queues now.
2288 	 */
2289 	ret = nvme_tcp_start_io_queues(ctrl, nr_queues,
2290 				       ctrl->tagset->nr_hw_queues + 1);
2291 	if (ret)
2292 		goto out_wait_freeze_timed_out;
2293 
2294 	return 0;
2295 
2296 out_wait_freeze_timed_out:
2297 	nvme_quiesce_io_queues(ctrl);
2298 	nvme_sync_io_queues(ctrl);
2299 	nvme_tcp_stop_io_queues(ctrl);
2300 out_cleanup_connect_q:
2301 	nvme_cancel_tagset(ctrl);
2302 	if (new)
2303 		nvme_remove_io_tag_set(ctrl);
2304 out_free_io_queues:
2305 	nvme_tcp_free_io_queues(ctrl);
2306 	return ret;
2307 }
2308 
nvme_tcp_configure_admin_queue(struct nvme_ctrl * ctrl,bool new)2309 static int nvme_tcp_configure_admin_queue(struct nvme_ctrl *ctrl, bool new)
2310 {
2311 	int error;
2312 
2313 	error = nvme_tcp_alloc_admin_queue(ctrl);
2314 	if (error)
2315 		return error;
2316 
2317 	if (new) {
2318 		error = nvme_alloc_admin_tag_set(ctrl,
2319 				&to_tcp_ctrl(ctrl)->admin_tag_set,
2320 				&nvme_tcp_admin_mq_ops,
2321 				sizeof(struct nvme_tcp_request));
2322 		if (error)
2323 			goto out_free_queue;
2324 	}
2325 
2326 	error = nvme_tcp_start_queue(ctrl, 0);
2327 	if (error)
2328 		goto out_cleanup_tagset;
2329 
2330 	if (ctrl->opts->concat && !ctrl->tls_pskid)
2331 		return 0;
2332 
2333 	error = nvme_enable_ctrl(ctrl);
2334 	if (error)
2335 		goto out_stop_queue;
2336 
2337 	nvme_unquiesce_admin_queue(ctrl);
2338 
2339 	error = nvme_init_ctrl_finish(ctrl, false);
2340 	if (error)
2341 		goto out_quiesce_queue;
2342 
2343 	return 0;
2344 
2345 out_quiesce_queue:
2346 	nvme_quiesce_admin_queue(ctrl);
2347 	blk_sync_queue(ctrl->admin_q);
2348 out_stop_queue:
2349 	nvme_tcp_stop_queue(ctrl, 0);
2350 	nvme_cancel_admin_tagset(ctrl);
2351 out_cleanup_tagset:
2352 	if (new)
2353 		nvme_remove_admin_tag_set(ctrl);
2354 out_free_queue:
2355 	nvme_tcp_free_admin_queue(ctrl);
2356 	return error;
2357 }
2358 
nvme_tcp_teardown_admin_queue(struct nvme_ctrl * ctrl,bool remove)2359 static void nvme_tcp_teardown_admin_queue(struct nvme_ctrl *ctrl,
2360 		bool remove)
2361 {
2362 	nvme_quiesce_admin_queue(ctrl);
2363 	blk_sync_queue(ctrl->admin_q);
2364 	nvme_tcp_stop_queue(ctrl, 0);
2365 	nvme_cancel_admin_tagset(ctrl);
2366 	if (remove) {
2367 		nvme_unquiesce_admin_queue(ctrl);
2368 		nvme_remove_admin_tag_set(ctrl);
2369 	}
2370 	nvme_tcp_free_admin_queue(ctrl);
2371 	if (ctrl->tls_pskid) {
2372 		dev_dbg(ctrl->device, "Wipe negotiated TLS_PSK %08x\n",
2373 			ctrl->tls_pskid);
2374 		ctrl->tls_pskid = 0;
2375 	}
2376 }
2377 
nvme_tcp_teardown_io_queues(struct nvme_ctrl * ctrl,bool remove)2378 static void nvme_tcp_teardown_io_queues(struct nvme_ctrl *ctrl,
2379 		bool remove)
2380 {
2381 	if (ctrl->queue_count <= 1)
2382 		return;
2383 	nvme_quiesce_io_queues(ctrl);
2384 	nvme_sync_io_queues(ctrl);
2385 	nvme_tcp_stop_io_queues(ctrl);
2386 	nvme_cancel_tagset(ctrl);
2387 	if (remove) {
2388 		nvme_unquiesce_io_queues(ctrl);
2389 		nvme_remove_io_tag_set(ctrl);
2390 	}
2391 	nvme_tcp_free_io_queues(ctrl);
2392 }
2393 
nvme_tcp_reconnect_or_remove(struct nvme_ctrl * ctrl,int status)2394 static void nvme_tcp_reconnect_or_remove(struct nvme_ctrl *ctrl,
2395 		int status)
2396 {
2397 	enum nvme_ctrl_state state = nvme_ctrl_state(ctrl);
2398 
2399 	/* If we are resetting/deleting then do nothing */
2400 	if (state != NVME_CTRL_CONNECTING) {
2401 		WARN_ON_ONCE(state == NVME_CTRL_NEW || state == NVME_CTRL_LIVE);
2402 		return;
2403 	}
2404 
2405 	if (nvmf_should_reconnect(ctrl, status)) {
2406 		dev_info(ctrl->device, "Reconnecting in %d seconds...\n",
2407 			ctrl->opts->reconnect_delay);
2408 		queue_delayed_work(nvme_wq, &to_tcp_ctrl(ctrl)->connect_work,
2409 				ctrl->opts->reconnect_delay * HZ);
2410 	} else {
2411 		dev_info(ctrl->device, "Removing controller (%d)...\n",
2412 			 status);
2413 		nvme_delete_ctrl(ctrl);
2414 	}
2415 }
2416 
2417 /*
2418  * The TLS key is set by secure concatenation after negotiation has been
2419  * completed on the admin queue. We need to revoke the key when:
2420  * - concatenation is enabled (otherwise it's a static key set by the user)
2421  * and
2422  * - the generated key is present in ctrl->tls_key (otherwise there's nothing
2423  *   to revoke)
2424  * and
2425  * - a valid PSK key ID has been set in ctrl->tls_pskid (otherwise TLS
2426  *   negotiation has not run).
2427  *
2428  * We cannot always revoke the key as nvme_tcp_alloc_admin_queue() is called
2429  * twice during secure concatenation, once on a 'normal' connection to run the
2430  * DH-HMAC-CHAP negotiation (which generates the key, so it _must not_ be set),
2431  * and once after the negotiation (which uses the key, so it _must_ be set).
2432  */
nvme_tcp_key_revoke_needed(struct nvme_ctrl * ctrl)2433 static bool nvme_tcp_key_revoke_needed(struct nvme_ctrl *ctrl)
2434 {
2435 	return ctrl->opts->concat && ctrl->opts->tls_key && ctrl->tls_pskid;
2436 }
2437 
nvme_tcp_setup_ctrl(struct nvme_ctrl * ctrl,bool new)2438 static int nvme_tcp_setup_ctrl(struct nvme_ctrl *ctrl, bool new)
2439 {
2440 	struct nvmf_ctrl_options *opts = ctrl->opts;
2441 	int ret;
2442 
2443 	ret = nvme_tcp_configure_admin_queue(ctrl, new);
2444 	if (ret)
2445 		return ret;
2446 
2447 	if (ctrl->opts->concat && !ctrl->tls_pskid) {
2448 		/* See comments for nvme_tcp_key_revoke_needed() */
2449 		dev_dbg(ctrl->device, "restart admin queue for secure concatenation\n");
2450 		nvme_stop_keep_alive(ctrl);
2451 		nvme_tcp_teardown_admin_queue(ctrl, false);
2452 		ret = nvme_tcp_configure_admin_queue(ctrl, false);
2453 		if (ret)
2454 			goto destroy_admin;
2455 	}
2456 
2457 	if (ctrl->icdoff) {
2458 		ret = -EOPNOTSUPP;
2459 		dev_err(ctrl->device, "icdoff is not supported!\n");
2460 		goto destroy_admin;
2461 	}
2462 
2463 	if (!nvme_ctrl_sgl_supported(ctrl)) {
2464 		ret = -EOPNOTSUPP;
2465 		dev_err(ctrl->device, "Mandatory sgls are not supported!\n");
2466 		goto destroy_admin;
2467 	}
2468 
2469 	if (opts->queue_size > ctrl->sqsize + 1)
2470 		dev_warn(ctrl->device,
2471 			"queue_size %zu > ctrl sqsize %u, clamping down\n",
2472 			opts->queue_size, ctrl->sqsize + 1);
2473 
2474 	if (ctrl->sqsize + 1 > ctrl->maxcmd) {
2475 		dev_warn(ctrl->device,
2476 			"sqsize %u > ctrl maxcmd %u, clamping down\n",
2477 			ctrl->sqsize + 1, ctrl->maxcmd);
2478 		ctrl->sqsize = ctrl->maxcmd - 1;
2479 	}
2480 
2481 	if (ctrl->queue_count > 1) {
2482 		ret = nvme_tcp_configure_io_queues(ctrl, new);
2483 		if (ret)
2484 			goto destroy_admin;
2485 	}
2486 
2487 	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE)) {
2488 		/*
2489 		 * state change failure is ok if we started ctrl delete,
2490 		 * unless we're during creation of a new controller to
2491 		 * avoid races with teardown flow.
2492 		 */
2493 		enum nvme_ctrl_state state = nvme_ctrl_state(ctrl);
2494 
2495 		WARN_ON_ONCE(state != NVME_CTRL_DELETING &&
2496 			     state != NVME_CTRL_DELETING_NOIO);
2497 		WARN_ON_ONCE(new);
2498 		ret = -EINVAL;
2499 		goto destroy_io;
2500 	}
2501 
2502 	nvme_start_ctrl(ctrl);
2503 	return 0;
2504 
2505 destroy_io:
2506 	if (ctrl->queue_count > 1) {
2507 		nvme_quiesce_io_queues(ctrl);
2508 		nvme_sync_io_queues(ctrl);
2509 		nvme_tcp_stop_io_queues(ctrl);
2510 		nvme_cancel_tagset(ctrl);
2511 		if (new)
2512 			nvme_remove_io_tag_set(ctrl);
2513 		nvme_tcp_free_io_queues(ctrl);
2514 	}
2515 destroy_admin:
2516 	nvme_stop_keep_alive(ctrl);
2517 	nvme_tcp_teardown_admin_queue(ctrl, new);
2518 	return ret;
2519 }
2520 
nvme_tcp_reconnect_ctrl_work(struct work_struct * work)2521 static void nvme_tcp_reconnect_ctrl_work(struct work_struct *work)
2522 {
2523 	struct nvme_tcp_ctrl *tcp_ctrl = container_of(to_delayed_work(work),
2524 			struct nvme_tcp_ctrl, connect_work);
2525 	struct nvme_ctrl *ctrl = &tcp_ctrl->ctrl;
2526 	int ret;
2527 
2528 	++ctrl->nr_reconnects;
2529 
2530 	ret = nvme_tcp_setup_ctrl(ctrl, false);
2531 	if (ret)
2532 		goto requeue;
2533 
2534 	dev_info(ctrl->device, "Successfully reconnected (attempt %d/%d)\n",
2535 		 ctrl->nr_reconnects, ctrl->opts->max_reconnects);
2536 
2537 	/* accumulate reconnect attempts before resetting it to zero */
2538 	atomic_long_add(ctrl->nr_reconnects, &ctrl->acc_reconnects);
2539 	ctrl->nr_reconnects = 0;
2540 
2541 	return;
2542 
2543 requeue:
2544 	dev_info(ctrl->device, "Failed reconnect attempt %d/%d\n",
2545 		 ctrl->nr_reconnects, ctrl->opts->max_reconnects);
2546 	nvme_tcp_reconnect_or_remove(ctrl, ret);
2547 }
2548 
nvme_tcp_error_recovery_work(struct work_struct * work)2549 static void nvme_tcp_error_recovery_work(struct work_struct *work)
2550 {
2551 	struct nvme_tcp_ctrl *tcp_ctrl = container_of(work,
2552 				struct nvme_tcp_ctrl, err_work);
2553 	struct nvme_ctrl *ctrl = &tcp_ctrl->ctrl;
2554 
2555 	if (nvme_tcp_key_revoke_needed(ctrl))
2556 		nvme_auth_revoke_tls_key(ctrl);
2557 	nvme_stop_keep_alive(ctrl);
2558 	flush_work(&ctrl->async_event_work);
2559 	nvme_tcp_teardown_io_queues(ctrl, false);
2560 	/* unquiesce to fail fast pending requests */
2561 	nvme_unquiesce_io_queues(ctrl);
2562 	nvme_tcp_teardown_admin_queue(ctrl, false);
2563 	nvme_unquiesce_admin_queue(ctrl);
2564 	nvme_auth_stop(ctrl);
2565 
2566 	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_CONNECTING)) {
2567 		/* state change failure is ok if we started ctrl delete */
2568 		enum nvme_ctrl_state state = nvme_ctrl_state(ctrl);
2569 
2570 		WARN_ON_ONCE(state != NVME_CTRL_DELETING &&
2571 			     state != NVME_CTRL_DELETING_NOIO);
2572 		return;
2573 	}
2574 
2575 	nvme_tcp_reconnect_or_remove(ctrl, 0);
2576 }
2577 
nvme_tcp_teardown_ctrl(struct nvme_ctrl * ctrl,bool shutdown)2578 static void nvme_tcp_teardown_ctrl(struct nvme_ctrl *ctrl, bool shutdown)
2579 {
2580 	nvme_tcp_teardown_io_queues(ctrl, shutdown);
2581 	nvme_quiesce_admin_queue(ctrl);
2582 	nvme_disable_ctrl(ctrl, shutdown);
2583 	nvme_tcp_teardown_admin_queue(ctrl, shutdown);
2584 }
2585 
nvme_tcp_delete_ctrl(struct nvme_ctrl * ctrl)2586 static void nvme_tcp_delete_ctrl(struct nvme_ctrl *ctrl)
2587 {
2588 	nvme_tcp_teardown_ctrl(ctrl, true);
2589 }
2590 
nvme_reset_ctrl_work(struct work_struct * work)2591 static void nvme_reset_ctrl_work(struct work_struct *work)
2592 {
2593 	struct nvme_ctrl *ctrl =
2594 		container_of(work, struct nvme_ctrl, reset_work);
2595 	int ret;
2596 
2597 	if (nvme_tcp_key_revoke_needed(ctrl))
2598 		nvme_auth_revoke_tls_key(ctrl);
2599 	nvme_stop_ctrl(ctrl);
2600 	nvme_tcp_teardown_ctrl(ctrl, false);
2601 
2602 	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_CONNECTING)) {
2603 		/* state change failure is ok if we started ctrl delete */
2604 		enum nvme_ctrl_state state = nvme_ctrl_state(ctrl);
2605 
2606 		WARN_ON_ONCE(state != NVME_CTRL_DELETING &&
2607 			     state != NVME_CTRL_DELETING_NOIO);
2608 		return;
2609 	}
2610 
2611 	ret = nvme_tcp_setup_ctrl(ctrl, false);
2612 	if (ret)
2613 		goto out_fail;
2614 
2615 	return;
2616 
2617 out_fail:
2618 	++ctrl->nr_reconnects;
2619 	nvme_tcp_reconnect_or_remove(ctrl, ret);
2620 }
2621 
nvme_tcp_stop_ctrl(struct nvme_ctrl * ctrl)2622 static void nvme_tcp_stop_ctrl(struct nvme_ctrl *ctrl)
2623 {
2624 	flush_work(&to_tcp_ctrl(ctrl)->err_work);
2625 	cancel_delayed_work_sync(&to_tcp_ctrl(ctrl)->connect_work);
2626 }
2627 
nvme_tcp_free_ctrl(struct nvme_ctrl * nctrl)2628 static void nvme_tcp_free_ctrl(struct nvme_ctrl *nctrl)
2629 {
2630 	struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(nctrl);
2631 
2632 	if (list_empty_careful(&ctrl->list))
2633 		goto free_ctrl;
2634 
2635 	mutex_lock(&nvme_tcp_ctrl_mutex);
2636 	list_del(&ctrl->list);
2637 	mutex_unlock(&nvme_tcp_ctrl_mutex);
2638 
2639 	nvmf_free_options(nctrl->opts);
2640 free_ctrl:
2641 	kfree(ctrl->queues);
2642 	kfree(ctrl);
2643 }
2644 
nvme_tcp_set_sg_null(struct nvme_command * c)2645 static void nvme_tcp_set_sg_null(struct nvme_command *c)
2646 {
2647 	struct nvme_sgl_desc *sg = &c->common.dptr.sgl;
2648 
2649 	sg->addr = 0;
2650 	sg->length = 0;
2651 	sg->type = (NVME_TRANSPORT_SGL_DATA_DESC << 4) |
2652 			NVME_SGL_FMT_TRANSPORT_A;
2653 }
2654 
nvme_tcp_set_sg_inline(struct nvme_tcp_queue * queue,struct nvme_command * c,u32 data_len)2655 static void nvme_tcp_set_sg_inline(struct nvme_tcp_queue *queue,
2656 		struct nvme_command *c, u32 data_len)
2657 {
2658 	struct nvme_sgl_desc *sg = &c->common.dptr.sgl;
2659 
2660 	sg->addr = cpu_to_le64(queue->ctrl->ctrl.icdoff);
2661 	sg->length = cpu_to_le32(data_len);
2662 	sg->type = (NVME_SGL_FMT_DATA_DESC << 4) | NVME_SGL_FMT_OFFSET;
2663 }
2664 
nvme_tcp_set_sg_host_data(struct nvme_command * c,u32 data_len)2665 static void nvme_tcp_set_sg_host_data(struct nvme_command *c,
2666 		u32 data_len)
2667 {
2668 	struct nvme_sgl_desc *sg = &c->common.dptr.sgl;
2669 
2670 	sg->addr = 0;
2671 	sg->length = cpu_to_le32(data_len);
2672 	sg->type = (NVME_TRANSPORT_SGL_DATA_DESC << 4) |
2673 			NVME_SGL_FMT_TRANSPORT_A;
2674 }
2675 
nvme_tcp_submit_async_event(struct nvme_ctrl * arg)2676 static void nvme_tcp_submit_async_event(struct nvme_ctrl *arg)
2677 {
2678 	struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(arg);
2679 	struct nvme_tcp_queue *queue = &ctrl->queues[0];
2680 	struct nvme_tcp_cmd_pdu *pdu = ctrl->async_req.pdu;
2681 	struct nvme_command *cmd = &pdu->cmd;
2682 	u8 hdgst = nvme_tcp_hdgst_len(queue);
2683 
2684 	memset(pdu, 0, sizeof(*pdu));
2685 	pdu->hdr.type = nvme_tcp_cmd;
2686 	if (queue->hdr_digest)
2687 		pdu->hdr.flags |= NVME_TCP_F_HDGST;
2688 	pdu->hdr.hlen = sizeof(*pdu);
2689 	pdu->hdr.plen = cpu_to_le32(pdu->hdr.hlen + hdgst);
2690 
2691 	cmd->common.opcode = nvme_admin_async_event;
2692 	cmd->common.command_id = NVME_AQ_BLK_MQ_DEPTH;
2693 	cmd->common.flags |= NVME_CMD_SGL_METABUF;
2694 	nvme_tcp_set_sg_null(cmd);
2695 
2696 	ctrl->async_req.state = NVME_TCP_SEND_CMD_PDU;
2697 	ctrl->async_req.offset = 0;
2698 	ctrl->async_req.curr_bio = NULL;
2699 	ctrl->async_req.data_len = 0;
2700 	init_llist_node(&ctrl->async_req.lentry);
2701 	INIT_LIST_HEAD(&ctrl->async_req.entry);
2702 
2703 	nvme_tcp_queue_request(&ctrl->async_req, true);
2704 }
2705 
nvme_tcp_complete_timed_out(struct request * rq)2706 static void nvme_tcp_complete_timed_out(struct request *rq)
2707 {
2708 	struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
2709 	struct nvme_ctrl *ctrl = &req->queue->ctrl->ctrl;
2710 
2711 	nvme_tcp_stop_queue(ctrl, nvme_tcp_queue_id(req->queue));
2712 	nvmf_complete_timed_out_request(rq);
2713 }
2714 
nvme_tcp_timeout(struct request * rq)2715 static enum blk_eh_timer_return nvme_tcp_timeout(struct request *rq)
2716 {
2717 	struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
2718 	struct nvme_ctrl *ctrl = &req->queue->ctrl->ctrl;
2719 	struct nvme_tcp_cmd_pdu *pdu = nvme_tcp_req_cmd_pdu(req);
2720 	struct nvme_command *cmd = &pdu->cmd;
2721 	int qid = nvme_tcp_queue_id(req->queue);
2722 
2723 	dev_warn(ctrl->device,
2724 		 "I/O tag %d (%04x) type %d opcode %#x (%s) QID %d timeout\n",
2725 		 rq->tag, nvme_cid(rq), pdu->hdr.type, cmd->common.opcode,
2726 		 nvme_fabrics_opcode_str(qid, cmd), qid);
2727 
2728 	if (nvme_ctrl_state(ctrl) != NVME_CTRL_LIVE) {
2729 		/*
2730 		 * If we are resetting, connecting or deleting we should
2731 		 * complete immediately because we may block controller
2732 		 * teardown or setup sequence
2733 		 * - ctrl disable/shutdown fabrics requests
2734 		 * - connect requests
2735 		 * - initialization admin requests
2736 		 * - I/O requests that entered after unquiescing and
2737 		 *   the controller stopped responding
2738 		 *
2739 		 * All other requests should be cancelled by the error
2740 		 * recovery work, so it's fine that we fail it here.
2741 		 */
2742 		nvme_tcp_complete_timed_out(rq);
2743 		return BLK_EH_DONE;
2744 	}
2745 
2746 	/*
2747 	 * LIVE state should trigger the normal error recovery which will
2748 	 * handle completing this request.
2749 	 */
2750 	nvme_tcp_error_recovery(ctrl);
2751 	return BLK_EH_RESET_TIMER;
2752 }
2753 
nvme_tcp_map_data(struct nvme_tcp_queue * queue,struct request * rq)2754 static blk_status_t nvme_tcp_map_data(struct nvme_tcp_queue *queue,
2755 			struct request *rq)
2756 {
2757 	struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
2758 	struct nvme_tcp_cmd_pdu *pdu = nvme_tcp_req_cmd_pdu(req);
2759 	struct nvme_command *c = &pdu->cmd;
2760 
2761 	c->common.flags |= NVME_CMD_SGL_METABUF;
2762 
2763 	if (!blk_rq_nr_phys_segments(rq))
2764 		nvme_tcp_set_sg_null(c);
2765 	else if (rq_data_dir(rq) == WRITE &&
2766 	    req->data_len <= nvme_tcp_inline_data_size(req))
2767 		nvme_tcp_set_sg_inline(queue, c, req->data_len);
2768 	else
2769 		nvme_tcp_set_sg_host_data(c, req->data_len);
2770 
2771 	return 0;
2772 }
2773 
nvme_tcp_setup_cmd_pdu(struct nvme_ns * ns,struct request * rq)2774 static blk_status_t nvme_tcp_setup_cmd_pdu(struct nvme_ns *ns,
2775 		struct request *rq)
2776 {
2777 	struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
2778 	struct nvme_tcp_cmd_pdu *pdu = nvme_tcp_req_cmd_pdu(req);
2779 	struct nvme_tcp_queue *queue = req->queue;
2780 	u8 hdgst = nvme_tcp_hdgst_len(queue), ddgst = 0;
2781 	blk_status_t ret;
2782 
2783 	ret = nvme_setup_cmd(ns, rq);
2784 	if (ret)
2785 		return ret;
2786 
2787 	req->state = NVME_TCP_SEND_CMD_PDU;
2788 	req->status = cpu_to_le16(NVME_SC_SUCCESS);
2789 	req->offset = 0;
2790 	req->data_sent = 0;
2791 	req->data_recvd = 0;
2792 	req->pdu_len = 0;
2793 	req->pdu_sent = 0;
2794 	req->h2cdata_left = 0;
2795 	req->data_len = blk_rq_nr_phys_segments(rq) ?
2796 				blk_rq_payload_bytes(rq) : 0;
2797 	req->curr_bio = rq->bio;
2798 	if (req->curr_bio && req->data_len)
2799 		nvme_tcp_init_iter(req, rq_data_dir(rq));
2800 
2801 	if (rq_data_dir(rq) == WRITE &&
2802 	    req->data_len <= nvme_tcp_inline_data_size(req))
2803 		req->pdu_len = req->data_len;
2804 
2805 	pdu->hdr.type = nvme_tcp_cmd;
2806 	pdu->hdr.flags = 0;
2807 	if (queue->hdr_digest)
2808 		pdu->hdr.flags |= NVME_TCP_F_HDGST;
2809 	if (queue->data_digest && req->pdu_len) {
2810 		pdu->hdr.flags |= NVME_TCP_F_DDGST;
2811 		ddgst = nvme_tcp_ddgst_len(queue);
2812 	}
2813 	pdu->hdr.hlen = sizeof(*pdu);
2814 	pdu->hdr.pdo = req->pdu_len ? pdu->hdr.hlen + hdgst : 0;
2815 	pdu->hdr.plen =
2816 		cpu_to_le32(pdu->hdr.hlen + hdgst + req->pdu_len + ddgst);
2817 
2818 	ret = nvme_tcp_map_data(queue, rq);
2819 	if (unlikely(ret)) {
2820 		nvme_cleanup_cmd(rq);
2821 		dev_err(queue->ctrl->ctrl.device,
2822 			"Failed to map data (%d)\n", ret);
2823 		return ret;
2824 	}
2825 
2826 	return 0;
2827 }
2828 
nvme_tcp_commit_rqs(struct blk_mq_hw_ctx * hctx)2829 static void nvme_tcp_commit_rqs(struct blk_mq_hw_ctx *hctx)
2830 {
2831 	struct nvme_tcp_queue *queue = hctx->driver_data;
2832 
2833 	if (!llist_empty(&queue->req_list))
2834 		queue_work_on(queue->io_cpu, nvme_tcp_wq, &queue->io_work);
2835 }
2836 
nvme_tcp_queue_rq(struct blk_mq_hw_ctx * hctx,const struct blk_mq_queue_data * bd)2837 static blk_status_t nvme_tcp_queue_rq(struct blk_mq_hw_ctx *hctx,
2838 		const struct blk_mq_queue_data *bd)
2839 {
2840 	struct nvme_ns *ns = hctx->queue->queuedata;
2841 	struct nvme_tcp_queue *queue = hctx->driver_data;
2842 	struct request *rq = bd->rq;
2843 	struct nvme_tcp_request *req = blk_mq_rq_to_pdu(rq);
2844 	bool queue_ready = test_bit(NVME_TCP_Q_LIVE, &queue->flags);
2845 	blk_status_t ret;
2846 
2847 	if (!nvme_check_ready(&queue->ctrl->ctrl, rq, queue_ready))
2848 		return nvme_fail_nonready_command(&queue->ctrl->ctrl, rq);
2849 
2850 	ret = nvme_tcp_setup_cmd_pdu(ns, rq);
2851 	if (unlikely(ret))
2852 		return ret;
2853 
2854 	nvme_start_request(rq);
2855 
2856 	nvme_tcp_queue_request(req, bd->last);
2857 
2858 	return BLK_STS_OK;
2859 }
2860 
nvme_tcp_map_queues(struct blk_mq_tag_set * set)2861 static void nvme_tcp_map_queues(struct blk_mq_tag_set *set)
2862 {
2863 	struct nvme_tcp_ctrl *ctrl = to_tcp_ctrl(set->driver_data);
2864 
2865 	nvmf_map_queues(set, &ctrl->ctrl, ctrl->io_queues);
2866 }
2867 
nvme_tcp_poll(struct blk_mq_hw_ctx * hctx,struct io_comp_batch * iob)2868 static int nvme_tcp_poll(struct blk_mq_hw_ctx *hctx, struct io_comp_batch *iob)
2869 {
2870 	struct nvme_tcp_queue *queue = hctx->driver_data;
2871 	struct sock *sk = queue->sock->sk;
2872 	int ret;
2873 
2874 	if (!test_bit(NVME_TCP_Q_LIVE, &queue->flags))
2875 		return 0;
2876 
2877 	set_bit(NVME_TCP_Q_POLLING, &queue->flags);
2878 	if (sk_can_busy_loop(sk) && skb_queue_empty_lockless(&sk->sk_receive_queue))
2879 		sk_busy_loop(sk, true);
2880 	ret = nvme_tcp_try_recv(queue);
2881 	clear_bit(NVME_TCP_Q_POLLING, &queue->flags);
2882 	return ret < 0 ? ret : queue->nr_cqe;
2883 }
2884 
nvme_tcp_get_address(struct nvme_ctrl * ctrl,char * buf,int size)2885 static int nvme_tcp_get_address(struct nvme_ctrl *ctrl, char *buf, int size)
2886 {
2887 	struct nvme_tcp_queue *queue = &to_tcp_ctrl(ctrl)->queues[0];
2888 	struct sockaddr_storage src_addr;
2889 	int ret, len;
2890 
2891 	len = nvmf_get_address(ctrl, buf, size);
2892 
2893 	if (!test_bit(NVME_TCP_Q_LIVE, &queue->flags))
2894 		return len;
2895 
2896 	mutex_lock(&queue->queue_lock);
2897 
2898 	ret = kernel_getsockname(queue->sock, (struct sockaddr *)&src_addr);
2899 	if (ret > 0) {
2900 		if (len > 0)
2901 			len--; /* strip trailing newline */
2902 		len += scnprintf(buf + len, size - len, "%ssrc_addr=%pISc\n",
2903 				(len) ? "," : "", &src_addr);
2904 	}
2905 
2906 	mutex_unlock(&queue->queue_lock);
2907 
2908 	return len;
2909 }
2910 
2911 static const struct blk_mq_ops nvme_tcp_mq_ops = {
2912 	.queue_rq	= nvme_tcp_queue_rq,
2913 	.commit_rqs	= nvme_tcp_commit_rqs,
2914 	.complete	= nvme_complete_rq,
2915 	.init_request	= nvme_tcp_init_request,
2916 	.exit_request	= nvme_tcp_exit_request,
2917 	.init_hctx	= nvme_tcp_init_hctx,
2918 	.timeout	= nvme_tcp_timeout,
2919 	.map_queues	= nvme_tcp_map_queues,
2920 	.poll		= nvme_tcp_poll,
2921 };
2922 
2923 static const struct blk_mq_ops nvme_tcp_admin_mq_ops = {
2924 	.queue_rq	= nvme_tcp_queue_rq,
2925 	.complete	= nvme_complete_rq,
2926 	.init_request	= nvme_tcp_init_request,
2927 	.exit_request	= nvme_tcp_exit_request,
2928 	.init_hctx	= nvme_tcp_init_admin_hctx,
2929 	.timeout	= nvme_tcp_timeout,
2930 };
2931 
2932 static const struct nvme_ctrl_ops nvme_tcp_ctrl_ops = {
2933 	.name			= "tcp",
2934 	.module			= THIS_MODULE,
2935 	.flags			= NVME_F_FABRICS | NVME_F_BLOCKING,
2936 	.reg_read32		= nvmf_reg_read32,
2937 	.reg_read64		= nvmf_reg_read64,
2938 	.reg_write32		= nvmf_reg_write32,
2939 	.subsystem_reset	= nvmf_subsystem_reset,
2940 	.free_ctrl		= nvme_tcp_free_ctrl,
2941 	.submit_async_event	= nvme_tcp_submit_async_event,
2942 	.delete_ctrl		= nvme_tcp_delete_ctrl,
2943 	.get_address		= nvme_tcp_get_address,
2944 	.stop_ctrl		= nvme_tcp_stop_ctrl,
2945 	.get_virt_boundary	= nvmf_get_virt_boundary,
2946 };
2947 
2948 static bool
nvme_tcp_existing_controller(struct nvmf_ctrl_options * opts)2949 nvme_tcp_existing_controller(struct nvmf_ctrl_options *opts)
2950 {
2951 	struct nvme_tcp_ctrl *ctrl;
2952 	bool found = false;
2953 
2954 	mutex_lock(&nvme_tcp_ctrl_mutex);
2955 	list_for_each_entry(ctrl, &nvme_tcp_ctrl_list, list) {
2956 		found = nvmf_ip_options_match(&ctrl->ctrl, opts);
2957 		if (found)
2958 			break;
2959 	}
2960 	mutex_unlock(&nvme_tcp_ctrl_mutex);
2961 
2962 	return found;
2963 }
2964 
nvme_tcp_alloc_ctrl(struct device * dev,struct nvmf_ctrl_options * opts)2965 static struct nvme_tcp_ctrl *nvme_tcp_alloc_ctrl(struct device *dev,
2966 		struct nvmf_ctrl_options *opts)
2967 {
2968 	struct nvme_tcp_ctrl *ctrl;
2969 	int ret;
2970 
2971 	ctrl = kzalloc_obj(*ctrl);
2972 	if (!ctrl)
2973 		return ERR_PTR(-ENOMEM);
2974 
2975 	/*
2976 	 * Safe to init list while allocating ctrl object.
2977 	 */
2978 	context_unsafe(INIT_LIST_HEAD(&ctrl->list));
2979 	ctrl->ctrl.opts = opts;
2980 	ctrl->ctrl.queue_count = opts->nr_io_queues + opts->nr_write_queues +
2981 				opts->nr_poll_queues + 1;
2982 	ctrl->ctrl.sqsize = opts->queue_size - 1;
2983 	ctrl->ctrl.kato = opts->kato;
2984 
2985 	INIT_DELAYED_WORK(&ctrl->connect_work,
2986 			nvme_tcp_reconnect_ctrl_work);
2987 	INIT_WORK(&ctrl->err_work, nvme_tcp_error_recovery_work);
2988 	INIT_WORK(&ctrl->ctrl.reset_work, nvme_reset_ctrl_work);
2989 
2990 	if (!(opts->mask & NVMF_OPT_TRSVCID)) {
2991 		opts->trsvcid =
2992 			kstrdup(__stringify(NVME_TCP_DISC_PORT), GFP_KERNEL);
2993 		if (!opts->trsvcid) {
2994 			ret = -ENOMEM;
2995 			goto out_free_ctrl;
2996 		}
2997 		opts->mask |= NVMF_OPT_TRSVCID;
2998 	}
2999 
3000 	ret = inet_pton_with_scope(&init_net, AF_UNSPEC,
3001 			opts->traddr, opts->trsvcid, &ctrl->addr);
3002 	if (ret) {
3003 		pr_err("malformed address passed: %s:%s\n",
3004 			opts->traddr, opts->trsvcid);
3005 		goto out_free_ctrl;
3006 	}
3007 
3008 	if (opts->mask & NVMF_OPT_HOST_TRADDR) {
3009 		ret = inet_pton_with_scope(&init_net, AF_UNSPEC,
3010 			opts->host_traddr, NULL, &ctrl->src_addr);
3011 		if (ret) {
3012 			pr_err("malformed src address passed: %s\n",
3013 			       opts->host_traddr);
3014 			goto out_free_ctrl;
3015 		}
3016 	}
3017 
3018 	if (opts->mask & NVMF_OPT_HOST_IFACE) {
3019 		if (!__dev_get_by_name(current->nsproxy->net_ns,
3020 				       opts->host_iface)) {
3021 			pr_err("invalid interface passed: %s\n",
3022 			       opts->host_iface);
3023 			ret = -ENODEV;
3024 			goto out_free_ctrl;
3025 		}
3026 	}
3027 
3028 	if (!opts->duplicate_connect && nvme_tcp_existing_controller(opts)) {
3029 		ret = -EALREADY;
3030 		goto out_free_ctrl;
3031 	}
3032 
3033 	ctrl->queues = kzalloc_objs(*ctrl->queues, ctrl->ctrl.queue_count);
3034 	if (!ctrl->queues) {
3035 		ret = -ENOMEM;
3036 		goto out_free_ctrl;
3037 	}
3038 
3039 	ret = nvme_init_ctrl(&ctrl->ctrl, dev, &nvme_tcp_ctrl_ops, 0);
3040 	if (ret)
3041 		goto out_kfree_queues;
3042 
3043 	return ctrl;
3044 out_kfree_queues:
3045 	kfree(ctrl->queues);
3046 out_free_ctrl:
3047 	kfree(ctrl);
3048 	return ERR_PTR(ret);
3049 }
3050 
nvme_tcp_create_ctrl(struct device * dev,struct nvmf_ctrl_options * opts)3051 static struct nvme_ctrl *nvme_tcp_create_ctrl(struct device *dev,
3052 		struct nvmf_ctrl_options *opts)
3053 {
3054 	struct nvme_tcp_ctrl *ctrl;
3055 	int ret;
3056 
3057 	ctrl = nvme_tcp_alloc_ctrl(dev, opts);
3058 	if (IS_ERR(ctrl))
3059 		return ERR_CAST(ctrl);
3060 
3061 	ret = nvme_add_ctrl(&ctrl->ctrl);
3062 	if (ret)
3063 		goto out_put_ctrl;
3064 
3065 	if (!nvme_change_ctrl_state(&ctrl->ctrl, NVME_CTRL_CONNECTING)) {
3066 		WARN_ON_ONCE(1);
3067 		ret = -EINTR;
3068 		goto out_uninit_ctrl;
3069 	}
3070 
3071 	ret = nvme_tcp_setup_ctrl(&ctrl->ctrl, true);
3072 	if (ret)
3073 		goto out_uninit_ctrl;
3074 
3075 	dev_info(ctrl->ctrl.device, "new ctrl: NQN \"%s\", addr %pISp, hostnqn: %s\n",
3076 		nvmf_ctrl_subsysnqn(&ctrl->ctrl), &ctrl->addr, opts->host->nqn);
3077 
3078 	mutex_lock(&nvme_tcp_ctrl_mutex);
3079 	list_add_tail(&ctrl->list, &nvme_tcp_ctrl_list);
3080 	mutex_unlock(&nvme_tcp_ctrl_mutex);
3081 
3082 	return &ctrl->ctrl;
3083 
3084 out_uninit_ctrl:
3085 	nvme_uninit_ctrl(&ctrl->ctrl);
3086 out_put_ctrl:
3087 	nvme_put_ctrl(&ctrl->ctrl);
3088 	if (ret > 0)
3089 		ret = -EIO;
3090 	return ERR_PTR(ret);
3091 }
3092 
3093 static struct nvmf_transport_ops nvme_tcp_transport = {
3094 	.name		= "tcp",
3095 	.module		= THIS_MODULE,
3096 	.required_opts	= NVMF_OPT_TRADDR,
3097 	.allowed_opts	= NVMF_OPT_TRSVCID | NVMF_OPT_RECONNECT_DELAY |
3098 			  NVMF_OPT_HOST_TRADDR | NVMF_OPT_CTRL_LOSS_TMO |
3099 			  NVMF_OPT_HDR_DIGEST | NVMF_OPT_DATA_DIGEST |
3100 			  NVMF_OPT_NR_WRITE_QUEUES | NVMF_OPT_NR_POLL_QUEUES |
3101 			  NVMF_OPT_TOS | NVMF_OPT_HOST_IFACE | NVMF_OPT_TLS |
3102 			  NVMF_OPT_KEYRING | NVMF_OPT_TLS_KEY | NVMF_OPT_CONCAT,
3103 	.create_ctrl	= nvme_tcp_create_ctrl,
3104 };
3105 
nvme_tcp_init_module(void)3106 static int __init nvme_tcp_init_module(void)
3107 {
3108 	unsigned int wq_flags = WQ_MEM_RECLAIM | WQ_HIGHPRI | WQ_SYSFS;
3109 	int cpu;
3110 
3111 	BUILD_BUG_ON(sizeof(struct nvme_tcp_hdr) != 8);
3112 	BUILD_BUG_ON(sizeof(struct nvme_tcp_cmd_pdu) != 72);
3113 	BUILD_BUG_ON(sizeof(struct nvme_tcp_data_pdu) != 24);
3114 	BUILD_BUG_ON(sizeof(struct nvme_tcp_rsp_pdu) != 24);
3115 	BUILD_BUG_ON(sizeof(struct nvme_tcp_r2t_pdu) != 24);
3116 	BUILD_BUG_ON(sizeof(struct nvme_tcp_icreq_pdu) != 128);
3117 	BUILD_BUG_ON(sizeof(struct nvme_tcp_icresp_pdu) != 128);
3118 	BUILD_BUG_ON(sizeof(struct nvme_tcp_term_pdu) != 24);
3119 
3120 	if (wq_unbound)
3121 		wq_flags |= WQ_UNBOUND;
3122 	else
3123 		wq_flags |= WQ_PERCPU;
3124 
3125 	nvme_tcp_wq = alloc_workqueue("nvme_tcp_wq", wq_flags, 0);
3126 	if (!nvme_tcp_wq)
3127 		return -ENOMEM;
3128 
3129 	for_each_possible_cpu(cpu)
3130 		atomic_set(&nvme_tcp_cpu_queues[cpu], 0);
3131 
3132 	nvmf_register_transport(&nvme_tcp_transport);
3133 	return 0;
3134 }
3135 
nvme_tcp_cleanup_module(void)3136 static void __exit nvme_tcp_cleanup_module(void)
3137 {
3138 	struct nvme_tcp_ctrl *ctrl;
3139 
3140 	nvmf_unregister_transport(&nvme_tcp_transport);
3141 
3142 	mutex_lock(&nvme_tcp_ctrl_mutex);
3143 	list_for_each_entry(ctrl, &nvme_tcp_ctrl_list, list)
3144 		nvme_delete_ctrl(&ctrl->ctrl);
3145 	mutex_unlock(&nvme_tcp_ctrl_mutex);
3146 	flush_workqueue(nvme_delete_wq);
3147 
3148 	destroy_workqueue(nvme_tcp_wq);
3149 }
3150 
3151 module_init(nvme_tcp_init_module);
3152 module_exit(nvme_tcp_cleanup_module);
3153 
3154 MODULE_DESCRIPTION("NVMe host TCP transport driver");
3155 MODULE_LICENSE("GPL v2");
3156 MODULE_ALIAS("nvme-tcp");
3157