Linux 4.19.133
[linux/fpc-iii.git] / drivers / scsi / iscsi_tcp.c
blob7212e3a13fe6bfc307d2e2abb753b370ae6e37f2
1 /*
2 * iSCSI Initiator over TCP/IP Data-Path
4 * Copyright (C) 2004 Dmitry Yusupov
5 * Copyright (C) 2004 Alex Aizman
6 * Copyright (C) 2005 - 2006 Mike Christie
7 * Copyright (C) 2006 Red Hat, Inc. All rights reserved.
8 * maintained by open-iscsi@googlegroups.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published
12 * by the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * See the file COPYING included with this distribution for more details.
22 * Credits:
23 * Christoph Hellwig
24 * FUJITA Tomonori
25 * Arne Redlich
26 * Zhenyu Wang
29 #include <crypto/hash.h>
30 #include <linux/types.h>
31 #include <linux/inet.h>
32 #include <linux/slab.h>
33 #include <linux/sched/mm.h>
34 #include <linux/file.h>
35 #include <linux/blkdev.h>
36 #include <linux/delay.h>
37 #include <linux/kfifo.h>
38 #include <linux/scatterlist.h>
39 #include <linux/module.h>
40 #include <linux/backing-dev.h>
41 #include <net/tcp.h>
42 #include <scsi/scsi_cmnd.h>
43 #include <scsi/scsi_device.h>
44 #include <scsi/scsi_host.h>
45 #include <scsi/scsi.h>
46 #include <scsi/scsi_transport_iscsi.h>
48 #include "iscsi_tcp.h"
50 MODULE_AUTHOR("Mike Christie <michaelc@cs.wisc.edu>, "
51 "Dmitry Yusupov <dmitry_yus@yahoo.com>, "
52 "Alex Aizman <itn780@yahoo.com>");
53 MODULE_DESCRIPTION("iSCSI/TCP data-path");
54 MODULE_LICENSE("GPL");
56 static struct scsi_transport_template *iscsi_sw_tcp_scsi_transport;
57 static struct scsi_host_template iscsi_sw_tcp_sht;
58 static struct iscsi_transport iscsi_sw_tcp_transport;
60 static unsigned int iscsi_max_lun = ~0;
61 module_param_named(max_lun, iscsi_max_lun, uint, S_IRUGO);
63 static int iscsi_sw_tcp_dbg;
64 module_param_named(debug_iscsi_tcp, iscsi_sw_tcp_dbg, int,
65 S_IRUGO | S_IWUSR);
66 MODULE_PARM_DESC(debug_iscsi_tcp, "Turn on debugging for iscsi_tcp module "
67 "Set to 1 to turn on, and zero to turn off. Default is off.");
69 #define ISCSI_SW_TCP_DBG(_conn, dbg_fmt, arg...) \
70 do { \
71 if (iscsi_sw_tcp_dbg) \
72 iscsi_conn_printk(KERN_INFO, _conn, \
73 "%s " dbg_fmt, \
74 __func__, ##arg); \
75 } while (0);
78 /**
79 * iscsi_sw_tcp_recv - TCP receive in sendfile fashion
80 * @rd_desc: read descriptor
81 * @skb: socket buffer
82 * @offset: offset in skb
83 * @len: skb->len - offset
85 static int iscsi_sw_tcp_recv(read_descriptor_t *rd_desc, struct sk_buff *skb,
86 unsigned int offset, size_t len)
88 struct iscsi_conn *conn = rd_desc->arg.data;
89 unsigned int consumed, total_consumed = 0;
90 int status;
92 ISCSI_SW_TCP_DBG(conn, "in %d bytes\n", skb->len - offset);
94 do {
95 status = 0;
96 consumed = iscsi_tcp_recv_skb(conn, skb, offset, 0, &status);
97 offset += consumed;
98 total_consumed += consumed;
99 } while (consumed != 0 && status != ISCSI_TCP_SKB_DONE);
101 ISCSI_SW_TCP_DBG(conn, "read %d bytes status %d\n",
102 skb->len - offset, status);
103 return total_consumed;
107 * iscsi_sw_sk_state_check - check socket state
108 * @sk: socket
110 * If the socket is in CLOSE or CLOSE_WAIT we should
111 * not close the connection if there is still some
112 * data pending.
114 * Must be called with sk_callback_lock.
116 static inline int iscsi_sw_sk_state_check(struct sock *sk)
118 struct iscsi_conn *conn = sk->sk_user_data;
120 if ((sk->sk_state == TCP_CLOSE_WAIT || sk->sk_state == TCP_CLOSE) &&
121 (conn->session->state != ISCSI_STATE_LOGGING_OUT) &&
122 !atomic_read(&sk->sk_rmem_alloc)) {
123 ISCSI_SW_TCP_DBG(conn, "TCP_CLOSE|TCP_CLOSE_WAIT\n");
124 iscsi_conn_failure(conn, ISCSI_ERR_TCP_CONN_CLOSE);
125 return -ECONNRESET;
127 return 0;
130 static void iscsi_sw_tcp_data_ready(struct sock *sk)
132 struct iscsi_conn *conn;
133 struct iscsi_tcp_conn *tcp_conn;
134 read_descriptor_t rd_desc;
136 read_lock_bh(&sk->sk_callback_lock);
137 conn = sk->sk_user_data;
138 if (!conn) {
139 read_unlock_bh(&sk->sk_callback_lock);
140 return;
142 tcp_conn = conn->dd_data;
145 * Use rd_desc to pass 'conn' to iscsi_tcp_recv.
146 * We set count to 1 because we want the network layer to
147 * hand us all the skbs that are available. iscsi_tcp_recv
148 * handled pdus that cross buffers or pdus that still need data.
150 rd_desc.arg.data = conn;
151 rd_desc.count = 1;
152 tcp_read_sock(sk, &rd_desc, iscsi_sw_tcp_recv);
154 iscsi_sw_sk_state_check(sk);
156 /* If we had to (atomically) map a highmem page,
157 * unmap it now. */
158 iscsi_tcp_segment_unmap(&tcp_conn->in.segment);
159 read_unlock_bh(&sk->sk_callback_lock);
162 static void iscsi_sw_tcp_state_change(struct sock *sk)
164 struct iscsi_tcp_conn *tcp_conn;
165 struct iscsi_sw_tcp_conn *tcp_sw_conn;
166 struct iscsi_conn *conn;
167 void (*old_state_change)(struct sock *);
169 read_lock_bh(&sk->sk_callback_lock);
170 conn = sk->sk_user_data;
171 if (!conn) {
172 read_unlock_bh(&sk->sk_callback_lock);
173 return;
176 iscsi_sw_sk_state_check(sk);
178 tcp_conn = conn->dd_data;
179 tcp_sw_conn = tcp_conn->dd_data;
180 old_state_change = tcp_sw_conn->old_state_change;
182 read_unlock_bh(&sk->sk_callback_lock);
184 old_state_change(sk);
188 * iscsi_write_space - Called when more output buffer space is available
189 * @sk: socket space is available for
191 static void iscsi_sw_tcp_write_space(struct sock *sk)
193 struct iscsi_conn *conn;
194 struct iscsi_tcp_conn *tcp_conn;
195 struct iscsi_sw_tcp_conn *tcp_sw_conn;
196 void (*old_write_space)(struct sock *);
198 read_lock_bh(&sk->sk_callback_lock);
199 conn = sk->sk_user_data;
200 if (!conn) {
201 read_unlock_bh(&sk->sk_callback_lock);
202 return;
205 tcp_conn = conn->dd_data;
206 tcp_sw_conn = tcp_conn->dd_data;
207 old_write_space = tcp_sw_conn->old_write_space;
208 read_unlock_bh(&sk->sk_callback_lock);
210 old_write_space(sk);
212 ISCSI_SW_TCP_DBG(conn, "iscsi_write_space\n");
213 iscsi_conn_queue_work(conn);
216 static void iscsi_sw_tcp_conn_set_callbacks(struct iscsi_conn *conn)
218 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
219 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
220 struct sock *sk = tcp_sw_conn->sock->sk;
222 /* assign new callbacks */
223 write_lock_bh(&sk->sk_callback_lock);
224 sk->sk_user_data = conn;
225 tcp_sw_conn->old_data_ready = sk->sk_data_ready;
226 tcp_sw_conn->old_state_change = sk->sk_state_change;
227 tcp_sw_conn->old_write_space = sk->sk_write_space;
228 sk->sk_data_ready = iscsi_sw_tcp_data_ready;
229 sk->sk_state_change = iscsi_sw_tcp_state_change;
230 sk->sk_write_space = iscsi_sw_tcp_write_space;
231 write_unlock_bh(&sk->sk_callback_lock);
234 static void
235 iscsi_sw_tcp_conn_restore_callbacks(struct iscsi_conn *conn)
237 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
238 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
239 struct sock *sk = tcp_sw_conn->sock->sk;
241 /* restore socket callbacks, see also: iscsi_conn_set_callbacks() */
242 write_lock_bh(&sk->sk_callback_lock);
243 sk->sk_user_data = NULL;
244 sk->sk_data_ready = tcp_sw_conn->old_data_ready;
245 sk->sk_state_change = tcp_sw_conn->old_state_change;
246 sk->sk_write_space = tcp_sw_conn->old_write_space;
247 sk->sk_no_check_tx = 0;
248 write_unlock_bh(&sk->sk_callback_lock);
252 * iscsi_sw_tcp_xmit_segment - transmit segment
253 * @tcp_conn: the iSCSI TCP connection
254 * @segment: the buffer to transmnit
256 * This function transmits as much of the buffer as
257 * the network layer will accept, and returns the number of
258 * bytes transmitted.
260 * If CRC hashing is enabled, the function will compute the
261 * hash as it goes. When the entire segment has been transmitted,
262 * it will retrieve the hash value and send it as well.
264 static int iscsi_sw_tcp_xmit_segment(struct iscsi_tcp_conn *tcp_conn,
265 struct iscsi_segment *segment)
267 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
268 struct socket *sk = tcp_sw_conn->sock;
269 unsigned int copied = 0;
270 int r = 0;
272 while (!iscsi_tcp_segment_done(tcp_conn, segment, 0, r)) {
273 struct scatterlist *sg;
274 unsigned int offset, copy;
275 int flags = 0;
277 r = 0;
278 offset = segment->copied;
279 copy = segment->size - offset;
281 if (segment->total_copied + segment->size < segment->total_size)
282 flags |= MSG_MORE;
284 /* Use sendpage if we can; else fall back to sendmsg */
285 if (!segment->data) {
286 sg = segment->sg;
287 offset += segment->sg_offset + sg->offset;
288 r = tcp_sw_conn->sendpage(sk, sg_page(sg), offset,
289 copy, flags);
290 } else {
291 struct msghdr msg = { .msg_flags = flags };
292 struct kvec iov = {
293 .iov_base = segment->data + offset,
294 .iov_len = copy
297 r = kernel_sendmsg(sk, &msg, &iov, 1, copy);
300 if (r < 0) {
301 iscsi_tcp_segment_unmap(segment);
302 return r;
304 copied += r;
306 return copied;
310 * iscsi_sw_tcp_xmit - TCP transmit
311 * @conn: iscsi connection
313 static int iscsi_sw_tcp_xmit(struct iscsi_conn *conn)
315 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
316 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
317 struct iscsi_segment *segment = &tcp_sw_conn->out.segment;
318 unsigned int consumed = 0;
319 int rc = 0;
321 while (1) {
322 rc = iscsi_sw_tcp_xmit_segment(tcp_conn, segment);
324 * We may not have been able to send data because the conn
325 * is getting stopped. libiscsi will know so propagate err
326 * for it to do the right thing.
328 if (rc == -EAGAIN)
329 return rc;
330 else if (rc < 0) {
331 rc = ISCSI_ERR_XMIT_FAILED;
332 goto error;
333 } else if (rc == 0)
334 break;
336 consumed += rc;
338 if (segment->total_copied >= segment->total_size) {
339 if (segment->done != NULL) {
340 rc = segment->done(tcp_conn, segment);
341 if (rc != 0)
342 goto error;
347 ISCSI_SW_TCP_DBG(conn, "xmit %d bytes\n", consumed);
349 conn->txdata_octets += consumed;
350 return consumed;
352 error:
353 /* Transmit error. We could initiate error recovery
354 * here. */
355 ISCSI_SW_TCP_DBG(conn, "Error sending PDU, errno=%d\n", rc);
356 iscsi_conn_failure(conn, rc);
357 return -EIO;
361 * iscsi_tcp_xmit_qlen - return the number of bytes queued for xmit
362 * @conn: iscsi connection
364 static inline int iscsi_sw_tcp_xmit_qlen(struct iscsi_conn *conn)
366 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
367 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
368 struct iscsi_segment *segment = &tcp_sw_conn->out.segment;
370 return segment->total_copied - segment->total_size;
373 static int iscsi_sw_tcp_pdu_xmit(struct iscsi_task *task)
375 struct iscsi_conn *conn = task->conn;
376 unsigned int noreclaim_flag;
377 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
378 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
379 int rc = 0;
381 if (!tcp_sw_conn->sock) {
382 iscsi_conn_printk(KERN_ERR, conn,
383 "Transport not bound to socket!\n");
384 return -EINVAL;
387 noreclaim_flag = memalloc_noreclaim_save();
389 while (iscsi_sw_tcp_xmit_qlen(conn)) {
390 rc = iscsi_sw_tcp_xmit(conn);
391 if (rc == 0) {
392 rc = -EAGAIN;
393 break;
395 if (rc < 0)
396 break;
397 rc = 0;
400 memalloc_noreclaim_restore(noreclaim_flag);
401 return rc;
405 * This is called when we're done sending the header.
406 * Simply copy the data_segment to the send segment, and return.
408 static int iscsi_sw_tcp_send_hdr_done(struct iscsi_tcp_conn *tcp_conn,
409 struct iscsi_segment *segment)
411 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
413 tcp_sw_conn->out.segment = tcp_sw_conn->out.data_segment;
414 ISCSI_SW_TCP_DBG(tcp_conn->iscsi_conn,
415 "Header done. Next segment size %u total_size %u\n",
416 tcp_sw_conn->out.segment.size,
417 tcp_sw_conn->out.segment.total_size);
418 return 0;
421 static void iscsi_sw_tcp_send_hdr_prep(struct iscsi_conn *conn, void *hdr,
422 size_t hdrlen)
424 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
425 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
427 ISCSI_SW_TCP_DBG(conn, "%s\n", conn->hdrdgst_en ?
428 "digest enabled" : "digest disabled");
430 /* Clear the data segment - needs to be filled in by the
431 * caller using iscsi_tcp_send_data_prep() */
432 memset(&tcp_sw_conn->out.data_segment, 0,
433 sizeof(struct iscsi_segment));
435 /* If header digest is enabled, compute the CRC and
436 * place the digest into the same buffer. We make
437 * sure that both iscsi_tcp_task and mtask have
438 * sufficient room.
440 if (conn->hdrdgst_en) {
441 iscsi_tcp_dgst_header(tcp_sw_conn->tx_hash, hdr, hdrlen,
442 hdr + hdrlen);
443 hdrlen += ISCSI_DIGEST_SIZE;
446 /* Remember header pointer for later, when we need
447 * to decide whether there's a payload to go along
448 * with the header. */
449 tcp_sw_conn->out.hdr = hdr;
451 iscsi_segment_init_linear(&tcp_sw_conn->out.segment, hdr, hdrlen,
452 iscsi_sw_tcp_send_hdr_done, NULL);
456 * Prepare the send buffer for the payload data.
457 * Padding and checksumming will all be taken care
458 * of by the iscsi_segment routines.
460 static int
461 iscsi_sw_tcp_send_data_prep(struct iscsi_conn *conn, struct scatterlist *sg,
462 unsigned int count, unsigned int offset,
463 unsigned int len)
465 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
466 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
467 struct ahash_request *tx_hash = NULL;
468 unsigned int hdr_spec_len;
470 ISCSI_SW_TCP_DBG(conn, "offset=%d, datalen=%d %s\n", offset, len,
471 conn->datadgst_en ?
472 "digest enabled" : "digest disabled");
474 /* Make sure the datalen matches what the caller
475 said he would send. */
476 hdr_spec_len = ntoh24(tcp_sw_conn->out.hdr->dlength);
477 WARN_ON(iscsi_padded(len) != iscsi_padded(hdr_spec_len));
479 if (conn->datadgst_en)
480 tx_hash = tcp_sw_conn->tx_hash;
482 return iscsi_segment_seek_sg(&tcp_sw_conn->out.data_segment,
483 sg, count, offset, len,
484 NULL, tx_hash);
487 static void
488 iscsi_sw_tcp_send_linear_data_prep(struct iscsi_conn *conn, void *data,
489 size_t len)
491 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
492 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
493 struct ahash_request *tx_hash = NULL;
494 unsigned int hdr_spec_len;
496 ISCSI_SW_TCP_DBG(conn, "datalen=%zd %s\n", len, conn->datadgst_en ?
497 "digest enabled" : "digest disabled");
499 /* Make sure the datalen matches what the caller
500 said he would send. */
501 hdr_spec_len = ntoh24(tcp_sw_conn->out.hdr->dlength);
502 WARN_ON(iscsi_padded(len) != iscsi_padded(hdr_spec_len));
504 if (conn->datadgst_en)
505 tx_hash = tcp_sw_conn->tx_hash;
507 iscsi_segment_init_linear(&tcp_sw_conn->out.data_segment,
508 data, len, NULL, tx_hash);
511 static int iscsi_sw_tcp_pdu_init(struct iscsi_task *task,
512 unsigned int offset, unsigned int count)
514 struct iscsi_conn *conn = task->conn;
515 int err = 0;
517 iscsi_sw_tcp_send_hdr_prep(conn, task->hdr, task->hdr_len);
519 if (!count)
520 return 0;
522 if (!task->sc)
523 iscsi_sw_tcp_send_linear_data_prep(conn, task->data, count);
524 else {
525 struct scsi_data_buffer *sdb = scsi_out(task->sc);
527 err = iscsi_sw_tcp_send_data_prep(conn, sdb->table.sgl,
528 sdb->table.nents, offset,
529 count);
532 if (err) {
533 /* got invalid offset/len */
534 return -EIO;
536 return 0;
539 static int iscsi_sw_tcp_pdu_alloc(struct iscsi_task *task, uint8_t opcode)
541 struct iscsi_tcp_task *tcp_task = task->dd_data;
543 task->hdr = task->dd_data + sizeof(*tcp_task);
544 task->hdr_max = sizeof(struct iscsi_sw_tcp_hdrbuf) - ISCSI_DIGEST_SIZE;
545 return 0;
548 static struct iscsi_cls_conn *
549 iscsi_sw_tcp_conn_create(struct iscsi_cls_session *cls_session,
550 uint32_t conn_idx)
552 struct iscsi_conn *conn;
553 struct iscsi_cls_conn *cls_conn;
554 struct iscsi_tcp_conn *tcp_conn;
555 struct iscsi_sw_tcp_conn *tcp_sw_conn;
556 struct crypto_ahash *tfm;
558 cls_conn = iscsi_tcp_conn_setup(cls_session, sizeof(*tcp_sw_conn),
559 conn_idx);
560 if (!cls_conn)
561 return NULL;
562 conn = cls_conn->dd_data;
563 tcp_conn = conn->dd_data;
564 tcp_sw_conn = tcp_conn->dd_data;
566 tfm = crypto_alloc_ahash("crc32c", 0, CRYPTO_ALG_ASYNC);
567 if (IS_ERR(tfm))
568 goto free_conn;
570 tcp_sw_conn->tx_hash = ahash_request_alloc(tfm, GFP_KERNEL);
571 if (!tcp_sw_conn->tx_hash)
572 goto free_tfm;
573 ahash_request_set_callback(tcp_sw_conn->tx_hash, 0, NULL, NULL);
575 tcp_sw_conn->rx_hash = ahash_request_alloc(tfm, GFP_KERNEL);
576 if (!tcp_sw_conn->rx_hash)
577 goto free_tx_hash;
578 ahash_request_set_callback(tcp_sw_conn->rx_hash, 0, NULL, NULL);
580 tcp_conn->rx_hash = tcp_sw_conn->rx_hash;
582 return cls_conn;
584 free_tx_hash:
585 ahash_request_free(tcp_sw_conn->tx_hash);
586 free_tfm:
587 crypto_free_ahash(tfm);
588 free_conn:
589 iscsi_conn_printk(KERN_ERR, conn,
590 "Could not create connection due to crc32c "
591 "loading error. Make sure the crc32c "
592 "module is built as a module or into the "
593 "kernel\n");
594 iscsi_tcp_conn_teardown(cls_conn);
595 return NULL;
598 static void iscsi_sw_tcp_release_conn(struct iscsi_conn *conn)
600 struct iscsi_session *session = conn->session;
601 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
602 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
603 struct socket *sock = tcp_sw_conn->sock;
605 if (!sock)
606 return;
608 sock_hold(sock->sk);
609 iscsi_sw_tcp_conn_restore_callbacks(conn);
610 sock_put(sock->sk);
612 spin_lock_bh(&session->frwd_lock);
613 tcp_sw_conn->sock = NULL;
614 spin_unlock_bh(&session->frwd_lock);
615 sockfd_put(sock);
618 static void iscsi_sw_tcp_conn_destroy(struct iscsi_cls_conn *cls_conn)
620 struct iscsi_conn *conn = cls_conn->dd_data;
621 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
622 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
624 iscsi_sw_tcp_release_conn(conn);
626 ahash_request_free(tcp_sw_conn->rx_hash);
627 if (tcp_sw_conn->tx_hash) {
628 struct crypto_ahash *tfm;
630 tfm = crypto_ahash_reqtfm(tcp_sw_conn->tx_hash);
631 ahash_request_free(tcp_sw_conn->tx_hash);
632 crypto_free_ahash(tfm);
635 iscsi_tcp_conn_teardown(cls_conn);
638 static void iscsi_sw_tcp_conn_stop(struct iscsi_cls_conn *cls_conn, int flag)
640 struct iscsi_conn *conn = cls_conn->dd_data;
641 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
642 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
643 struct socket *sock = tcp_sw_conn->sock;
645 /* userspace may have goofed up and not bound us */
646 if (!sock)
647 return;
649 sock->sk->sk_err = EIO;
650 wake_up_interruptible(sk_sleep(sock->sk));
652 /* stop xmit side */
653 iscsi_suspend_tx(conn);
655 /* stop recv side and release socket */
656 iscsi_sw_tcp_release_conn(conn);
658 iscsi_conn_stop(cls_conn, flag);
661 static int
662 iscsi_sw_tcp_conn_bind(struct iscsi_cls_session *cls_session,
663 struct iscsi_cls_conn *cls_conn, uint64_t transport_eph,
664 int is_leading)
666 struct iscsi_session *session = cls_session->dd_data;
667 struct iscsi_conn *conn = cls_conn->dd_data;
668 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
669 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
670 struct sock *sk;
671 struct socket *sock;
672 int err;
674 /* lookup for existing socket */
675 sock = sockfd_lookup((int)transport_eph, &err);
676 if (!sock) {
677 iscsi_conn_printk(KERN_ERR, conn,
678 "sockfd_lookup failed %d\n", err);
679 return -EEXIST;
682 err = iscsi_conn_bind(cls_session, cls_conn, is_leading);
683 if (err)
684 goto free_socket;
686 spin_lock_bh(&session->frwd_lock);
687 /* bind iSCSI connection and socket */
688 tcp_sw_conn->sock = sock;
689 spin_unlock_bh(&session->frwd_lock);
691 /* setup Socket parameters */
692 sk = sock->sk;
693 sk->sk_reuse = SK_CAN_REUSE;
694 sk->sk_sndtimeo = 15 * HZ; /* FIXME: make it configurable */
695 sk->sk_allocation = GFP_ATOMIC;
696 sk_set_memalloc(sk);
698 iscsi_sw_tcp_conn_set_callbacks(conn);
699 tcp_sw_conn->sendpage = tcp_sw_conn->sock->ops->sendpage;
701 * set receive state machine into initial state
703 iscsi_tcp_hdr_recv_prep(tcp_conn);
704 return 0;
706 free_socket:
707 sockfd_put(sock);
708 return err;
711 static int iscsi_sw_tcp_conn_set_param(struct iscsi_cls_conn *cls_conn,
712 enum iscsi_param param, char *buf,
713 int buflen)
715 struct iscsi_conn *conn = cls_conn->dd_data;
716 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
717 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
719 switch(param) {
720 case ISCSI_PARAM_HDRDGST_EN:
721 iscsi_set_param(cls_conn, param, buf, buflen);
722 break;
723 case ISCSI_PARAM_DATADGST_EN:
724 iscsi_set_param(cls_conn, param, buf, buflen);
725 tcp_sw_conn->sendpage = conn->datadgst_en ?
726 sock_no_sendpage : tcp_sw_conn->sock->ops->sendpage;
727 break;
728 case ISCSI_PARAM_MAX_R2T:
729 return iscsi_tcp_set_max_r2t(conn, buf);
730 default:
731 return iscsi_set_param(cls_conn, param, buf, buflen);
734 return 0;
737 static int iscsi_sw_tcp_conn_get_param(struct iscsi_cls_conn *cls_conn,
738 enum iscsi_param param, char *buf)
740 struct iscsi_conn *conn = cls_conn->dd_data;
741 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
742 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
743 struct sockaddr_in6 addr;
744 int rc;
746 switch(param) {
747 case ISCSI_PARAM_CONN_PORT:
748 case ISCSI_PARAM_CONN_ADDRESS:
749 case ISCSI_PARAM_LOCAL_PORT:
750 spin_lock_bh(&conn->session->frwd_lock);
751 if (!tcp_sw_conn || !tcp_sw_conn->sock) {
752 spin_unlock_bh(&conn->session->frwd_lock);
753 return -ENOTCONN;
755 if (param == ISCSI_PARAM_LOCAL_PORT)
756 rc = kernel_getsockname(tcp_sw_conn->sock,
757 (struct sockaddr *)&addr);
758 else
759 rc = kernel_getpeername(tcp_sw_conn->sock,
760 (struct sockaddr *)&addr);
761 spin_unlock_bh(&conn->session->frwd_lock);
762 if (rc < 0)
763 return rc;
765 return iscsi_conn_get_addr_param((struct sockaddr_storage *)
766 &addr, param, buf);
767 default:
768 return iscsi_conn_get_param(cls_conn, param, buf);
771 return 0;
774 static int iscsi_sw_tcp_host_get_param(struct Scsi_Host *shost,
775 enum iscsi_host_param param, char *buf)
777 struct iscsi_sw_tcp_host *tcp_sw_host = iscsi_host_priv(shost);
778 struct iscsi_session *session = tcp_sw_host->session;
779 struct iscsi_conn *conn;
780 struct iscsi_tcp_conn *tcp_conn;
781 struct iscsi_sw_tcp_conn *tcp_sw_conn;
782 struct sockaddr_in6 addr;
783 int rc;
785 switch (param) {
786 case ISCSI_HOST_PARAM_IPADDRESS:
787 if (!session)
788 return -ENOTCONN;
790 spin_lock_bh(&session->frwd_lock);
791 conn = session->leadconn;
792 if (!conn) {
793 spin_unlock_bh(&session->frwd_lock);
794 return -ENOTCONN;
796 tcp_conn = conn->dd_data;
798 tcp_sw_conn = tcp_conn->dd_data;
799 if (!tcp_sw_conn->sock) {
800 spin_unlock_bh(&session->frwd_lock);
801 return -ENOTCONN;
804 rc = kernel_getsockname(tcp_sw_conn->sock,
805 (struct sockaddr *)&addr);
806 spin_unlock_bh(&session->frwd_lock);
807 if (rc < 0)
808 return rc;
810 return iscsi_conn_get_addr_param((struct sockaddr_storage *)
811 &addr,
812 (enum iscsi_param)param, buf);
813 default:
814 return iscsi_host_get_param(shost, param, buf);
817 return 0;
820 static void
821 iscsi_sw_tcp_conn_get_stats(struct iscsi_cls_conn *cls_conn,
822 struct iscsi_stats *stats)
824 struct iscsi_conn *conn = cls_conn->dd_data;
825 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
826 struct iscsi_sw_tcp_conn *tcp_sw_conn = tcp_conn->dd_data;
828 stats->custom_length = 3;
829 strcpy(stats->custom[0].desc, "tx_sendpage_failures");
830 stats->custom[0].value = tcp_sw_conn->sendpage_failures_cnt;
831 strcpy(stats->custom[1].desc, "rx_discontiguous_hdr");
832 stats->custom[1].value = tcp_sw_conn->discontiguous_hdr_cnt;
833 strcpy(stats->custom[2].desc, "eh_abort_cnt");
834 stats->custom[2].value = conn->eh_abort_cnt;
836 iscsi_tcp_conn_get_stats(cls_conn, stats);
839 static struct iscsi_cls_session *
840 iscsi_sw_tcp_session_create(struct iscsi_endpoint *ep, uint16_t cmds_max,
841 uint16_t qdepth, uint32_t initial_cmdsn)
843 struct iscsi_cls_session *cls_session;
844 struct iscsi_session *session;
845 struct iscsi_sw_tcp_host *tcp_sw_host;
846 struct Scsi_Host *shost;
848 if (ep) {
849 printk(KERN_ERR "iscsi_tcp: invalid ep %p.\n", ep);
850 return NULL;
853 shost = iscsi_host_alloc(&iscsi_sw_tcp_sht,
854 sizeof(struct iscsi_sw_tcp_host), 1);
855 if (!shost)
856 return NULL;
857 shost->transportt = iscsi_sw_tcp_scsi_transport;
858 shost->cmd_per_lun = qdepth;
859 shost->max_lun = iscsi_max_lun;
860 shost->max_id = 0;
861 shost->max_channel = 0;
862 shost->max_cmd_len = SCSI_MAX_VARLEN_CDB_SIZE;
864 if (iscsi_host_add(shost, NULL))
865 goto free_host;
867 cls_session = iscsi_session_setup(&iscsi_sw_tcp_transport, shost,
868 cmds_max, 0,
869 sizeof(struct iscsi_tcp_task) +
870 sizeof(struct iscsi_sw_tcp_hdrbuf),
871 initial_cmdsn, 0);
872 if (!cls_session)
873 goto remove_host;
874 session = cls_session->dd_data;
875 tcp_sw_host = iscsi_host_priv(shost);
876 tcp_sw_host->session = session;
878 shost->can_queue = session->scsi_cmds_max;
879 if (iscsi_tcp_r2tpool_alloc(session))
880 goto remove_session;
881 return cls_session;
883 remove_session:
884 iscsi_session_teardown(cls_session);
885 remove_host:
886 iscsi_host_remove(shost);
887 free_host:
888 iscsi_host_free(shost);
889 return NULL;
892 static void iscsi_sw_tcp_session_destroy(struct iscsi_cls_session *cls_session)
894 struct Scsi_Host *shost = iscsi_session_to_shost(cls_session);
895 struct iscsi_session *session = cls_session->dd_data;
897 if (WARN_ON_ONCE(session->leadconn))
898 return;
900 iscsi_tcp_r2tpool_free(cls_session->dd_data);
901 iscsi_session_teardown(cls_session);
903 iscsi_host_remove(shost);
904 iscsi_host_free(shost);
907 static umode_t iscsi_sw_tcp_attr_is_visible(int param_type, int param)
909 switch (param_type) {
910 case ISCSI_HOST_PARAM:
911 switch (param) {
912 case ISCSI_HOST_PARAM_NETDEV_NAME:
913 case ISCSI_HOST_PARAM_HWADDRESS:
914 case ISCSI_HOST_PARAM_IPADDRESS:
915 case ISCSI_HOST_PARAM_INITIATOR_NAME:
916 return S_IRUGO;
917 default:
918 return 0;
920 case ISCSI_PARAM:
921 switch (param) {
922 case ISCSI_PARAM_MAX_RECV_DLENGTH:
923 case ISCSI_PARAM_MAX_XMIT_DLENGTH:
924 case ISCSI_PARAM_HDRDGST_EN:
925 case ISCSI_PARAM_DATADGST_EN:
926 case ISCSI_PARAM_CONN_ADDRESS:
927 case ISCSI_PARAM_CONN_PORT:
928 case ISCSI_PARAM_LOCAL_PORT:
929 case ISCSI_PARAM_EXP_STATSN:
930 case ISCSI_PARAM_PERSISTENT_ADDRESS:
931 case ISCSI_PARAM_PERSISTENT_PORT:
932 case ISCSI_PARAM_PING_TMO:
933 case ISCSI_PARAM_RECV_TMO:
934 case ISCSI_PARAM_INITIAL_R2T_EN:
935 case ISCSI_PARAM_MAX_R2T:
936 case ISCSI_PARAM_IMM_DATA_EN:
937 case ISCSI_PARAM_FIRST_BURST:
938 case ISCSI_PARAM_MAX_BURST:
939 case ISCSI_PARAM_PDU_INORDER_EN:
940 case ISCSI_PARAM_DATASEQ_INORDER_EN:
941 case ISCSI_PARAM_ERL:
942 case ISCSI_PARAM_TARGET_NAME:
943 case ISCSI_PARAM_TPGT:
944 case ISCSI_PARAM_USERNAME:
945 case ISCSI_PARAM_PASSWORD:
946 case ISCSI_PARAM_USERNAME_IN:
947 case ISCSI_PARAM_PASSWORD_IN:
948 case ISCSI_PARAM_FAST_ABORT:
949 case ISCSI_PARAM_ABORT_TMO:
950 case ISCSI_PARAM_LU_RESET_TMO:
951 case ISCSI_PARAM_TGT_RESET_TMO:
952 case ISCSI_PARAM_IFACE_NAME:
953 case ISCSI_PARAM_INITIATOR_NAME:
954 return S_IRUGO;
955 default:
956 return 0;
960 return 0;
963 static int iscsi_sw_tcp_slave_alloc(struct scsi_device *sdev)
965 blk_queue_flag_set(QUEUE_FLAG_BIDI, sdev->request_queue);
966 return 0;
969 static int iscsi_sw_tcp_slave_configure(struct scsi_device *sdev)
971 struct iscsi_sw_tcp_host *tcp_sw_host = iscsi_host_priv(sdev->host);
972 struct iscsi_session *session = tcp_sw_host->session;
973 struct iscsi_conn *conn = session->leadconn;
975 if (conn->datadgst_en)
976 sdev->request_queue->backing_dev_info->capabilities
977 |= BDI_CAP_STABLE_WRITES;
978 blk_queue_dma_alignment(sdev->request_queue, 0);
979 return 0;
982 static struct scsi_host_template iscsi_sw_tcp_sht = {
983 .module = THIS_MODULE,
984 .name = "iSCSI Initiator over TCP/IP",
985 .queuecommand = iscsi_queuecommand,
986 .change_queue_depth = scsi_change_queue_depth,
987 .can_queue = ISCSI_DEF_XMIT_CMDS_MAX - 1,
988 .sg_tablesize = 4096,
989 .max_sectors = 0xFFFF,
990 .cmd_per_lun = ISCSI_DEF_CMD_PER_LUN,
991 .eh_timed_out = iscsi_eh_cmd_timed_out,
992 .eh_abort_handler = iscsi_eh_abort,
993 .eh_device_reset_handler= iscsi_eh_device_reset,
994 .eh_target_reset_handler = iscsi_eh_recover_target,
995 .use_clustering = DISABLE_CLUSTERING,
996 .slave_alloc = iscsi_sw_tcp_slave_alloc,
997 .slave_configure = iscsi_sw_tcp_slave_configure,
998 .target_alloc = iscsi_target_alloc,
999 .proc_name = "iscsi_tcp",
1000 .this_id = -1,
1001 .track_queue_depth = 1,
1004 static struct iscsi_transport iscsi_sw_tcp_transport = {
1005 .owner = THIS_MODULE,
1006 .name = "tcp",
1007 .caps = CAP_RECOVERY_L0 | CAP_MULTI_R2T | CAP_HDRDGST
1008 | CAP_DATADGST,
1009 /* session management */
1010 .create_session = iscsi_sw_tcp_session_create,
1011 .destroy_session = iscsi_sw_tcp_session_destroy,
1012 /* connection management */
1013 .create_conn = iscsi_sw_tcp_conn_create,
1014 .bind_conn = iscsi_sw_tcp_conn_bind,
1015 .destroy_conn = iscsi_sw_tcp_conn_destroy,
1016 .attr_is_visible = iscsi_sw_tcp_attr_is_visible,
1017 .set_param = iscsi_sw_tcp_conn_set_param,
1018 .get_conn_param = iscsi_sw_tcp_conn_get_param,
1019 .get_session_param = iscsi_session_get_param,
1020 .start_conn = iscsi_conn_start,
1021 .stop_conn = iscsi_sw_tcp_conn_stop,
1022 /* iscsi host params */
1023 .get_host_param = iscsi_sw_tcp_host_get_param,
1024 .set_host_param = iscsi_host_set_param,
1025 /* IO */
1026 .send_pdu = iscsi_conn_send_pdu,
1027 .get_stats = iscsi_sw_tcp_conn_get_stats,
1028 /* iscsi task/cmd helpers */
1029 .init_task = iscsi_tcp_task_init,
1030 .xmit_task = iscsi_tcp_task_xmit,
1031 .cleanup_task = iscsi_tcp_cleanup_task,
1032 /* low level pdu helpers */
1033 .xmit_pdu = iscsi_sw_tcp_pdu_xmit,
1034 .init_pdu = iscsi_sw_tcp_pdu_init,
1035 .alloc_pdu = iscsi_sw_tcp_pdu_alloc,
1036 /* recovery */
1037 .session_recovery_timedout = iscsi_session_recovery_timedout,
1040 static int __init iscsi_sw_tcp_init(void)
1042 if (iscsi_max_lun < 1) {
1043 printk(KERN_ERR "iscsi_tcp: Invalid max_lun value of %u\n",
1044 iscsi_max_lun);
1045 return -EINVAL;
1048 iscsi_sw_tcp_scsi_transport = iscsi_register_transport(
1049 &iscsi_sw_tcp_transport);
1050 if (!iscsi_sw_tcp_scsi_transport)
1051 return -ENODEV;
1053 return 0;
1056 static void __exit iscsi_sw_tcp_exit(void)
1058 iscsi_unregister_transport(&iscsi_sw_tcp_transport);
1061 module_init(iscsi_sw_tcp_init);
1062 module_exit(iscsi_sw_tcp_exit);