2 * iSCSI over TCP/IP Data-Path lib
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.
29 #include <linux/types.h>
30 #include <linux/list.h>
31 #include <linux/inet.h>
32 #include <linux/file.h>
33 #include <linux/blkdev.h>
34 #include <linux/crypto.h>
35 #include <linux/delay.h>
36 #include <linux/kfifo.h>
37 #include <linux/scatterlist.h>
39 #include <scsi/scsi_cmnd.h>
40 #include <scsi/scsi_device.h>
41 #include <scsi/scsi_host.h>
42 #include <scsi/scsi.h>
43 #include <scsi/scsi_transport_iscsi.h>
45 #include "iscsi_tcp.h"
47 MODULE_AUTHOR("Mike Christie <michaelc@cs.wisc.edu>, "
48 "Dmitry Yusupov <dmitry_yus@yahoo.com>, "
49 "Alex Aizman <itn780@yahoo.com>");
50 MODULE_DESCRIPTION("iSCSI/TCP data-path");
51 MODULE_LICENSE("GPL");
53 static int iscsi_dbg_libtcp
;
54 module_param_named(debug_libiscsi_tcp
, iscsi_dbg_libtcp
, int,
56 MODULE_PARM_DESC(debug_libiscsi_tcp
, "Turn on debugging for libiscsi_tcp "
57 "module. Set to 1 to turn on, and zero to turn off. Default "
60 #define ISCSI_DBG_TCP(_conn, dbg_fmt, arg...) \
62 if (iscsi_dbg_libtcp) \
63 iscsi_conn_printk(KERN_INFO, _conn, \
68 static int iscsi_tcp_hdr_recv_done(struct iscsi_tcp_conn
*tcp_conn
,
69 struct iscsi_segment
*segment
);
72 * Scatterlist handling: inside the iscsi_segment, we
73 * remember an index into the scatterlist, and set data/size
74 * to the current scatterlist entry. For highmem pages, we
77 * Note that the page is unmapped when we return from
78 * TCP's data_ready handler, so we may end up mapping and
79 * unmapping the same page repeatedly. The whole reason
80 * for this is that we shouldn't keep the page mapped
81 * outside the softirq.
85 * iscsi_tcp_segment_init_sg - init indicated scatterlist entry
86 * @segment: the buffer object
88 * @offset: byte offset into that sg entry
90 * This function sets up the segment so that subsequent
91 * data is copied to the indicated sg entry, at the given
95 iscsi_tcp_segment_init_sg(struct iscsi_segment
*segment
,
96 struct scatterlist
*sg
, unsigned int offset
)
99 segment
->sg_offset
= offset
;
100 segment
->size
= min(sg
->length
- offset
,
101 segment
->total_size
- segment
->total_copied
);
102 segment
->data
= NULL
;
106 * iscsi_tcp_segment_map - map the current S/G page
107 * @segment: iscsi_segment
108 * @recv: 1 if called from recv path
110 * We only need to possibly kmap data if scatter lists are being used,
111 * because the iscsi passthrough and internal IO paths will never use high
114 static void iscsi_tcp_segment_map(struct iscsi_segment
*segment
, int recv
)
116 struct scatterlist
*sg
;
118 if (segment
->data
!= NULL
|| !segment
->sg
)
122 BUG_ON(segment
->sg_mapped
);
123 BUG_ON(sg
->length
== 0);
126 * If the page count is greater than one it is ok to send
127 * to the network layer's zero copy send path. If not we
128 * have to go the slow sendmsg path. We always map for the
131 if (page_count(sg_page(sg
)) >= 1 && !recv
)
134 segment
->sg_mapped
= kmap_atomic(sg_page(sg
), KM_SOFTIRQ0
);
135 segment
->data
= segment
->sg_mapped
+ sg
->offset
+ segment
->sg_offset
;
138 void iscsi_tcp_segment_unmap(struct iscsi_segment
*segment
)
140 if (segment
->sg_mapped
) {
141 kunmap_atomic(segment
->sg_mapped
, KM_SOFTIRQ0
);
142 segment
->sg_mapped
= NULL
;
143 segment
->data
= NULL
;
146 EXPORT_SYMBOL_GPL(iscsi_tcp_segment_unmap
);
149 * Splice the digest buffer into the buffer
152 iscsi_tcp_segment_splice_digest(struct iscsi_segment
*segment
, void *digest
)
154 segment
->data
= digest
;
155 segment
->digest_len
= ISCSI_DIGEST_SIZE
;
156 segment
->total_size
+= ISCSI_DIGEST_SIZE
;
157 segment
->size
= ISCSI_DIGEST_SIZE
;
160 segment
->hash
= NULL
;
164 * iscsi_tcp_segment_done - check whether the segment is complete
165 * @tcp_conn: iscsi tcp connection
166 * @segment: iscsi segment to check
167 * @recv: set to one of this is called from the recv path
168 * @copied: number of bytes copied
170 * Check if we're done receiving this segment. If the receive
171 * buffer is full but we expect more data, move on to the
172 * next entry in the scatterlist.
174 * If the amount of data we received isn't a multiple of 4,
175 * we will transparently receive the pad bytes, too.
177 * This function must be re-entrant.
179 int iscsi_tcp_segment_done(struct iscsi_tcp_conn
*tcp_conn
,
180 struct iscsi_segment
*segment
, int recv
,
183 struct scatterlist sg
;
186 ISCSI_DBG_TCP(tcp_conn
->iscsi_conn
, "copied %u %u size %u %s\n",
187 segment
->copied
, copied
, segment
->size
,
188 recv
? "recv" : "xmit");
189 if (segment
->hash
&& copied
) {
191 * If a segment is kmapd we must unmap it before sending
192 * to the crypto layer since that will try to kmap it again.
194 iscsi_tcp_segment_unmap(segment
);
196 if (!segment
->data
) {
197 sg_init_table(&sg
, 1);
198 sg_set_page(&sg
, sg_page(segment
->sg
), copied
,
199 segment
->copied
+ segment
->sg_offset
+
200 segment
->sg
->offset
);
202 sg_init_one(&sg
, segment
->data
+ segment
->copied
,
204 crypto_hash_update(segment
->hash
, &sg
, copied
);
207 segment
->copied
+= copied
;
208 if (segment
->copied
< segment
->size
) {
209 iscsi_tcp_segment_map(segment
, recv
);
213 segment
->total_copied
+= segment
->copied
;
217 /* Unmap the current scatterlist page, if there is one. */
218 iscsi_tcp_segment_unmap(segment
);
220 /* Do we have more scatterlist entries? */
221 ISCSI_DBG_TCP(tcp_conn
->iscsi_conn
, "total copied %u total size %u\n",
222 segment
->total_copied
, segment
->total_size
);
223 if (segment
->total_copied
< segment
->total_size
) {
224 /* Proceed to the next entry in the scatterlist. */
225 iscsi_tcp_segment_init_sg(segment
, sg_next(segment
->sg
),
227 iscsi_tcp_segment_map(segment
, recv
);
228 BUG_ON(segment
->size
== 0);
232 /* Do we need to handle padding? */
233 if (!(tcp_conn
->iscsi_conn
->session
->tt
->caps
& CAP_PADDING_OFFLOAD
)) {
234 pad
= iscsi_padding(segment
->total_copied
);
236 ISCSI_DBG_TCP(tcp_conn
->iscsi_conn
,
237 "consume %d pad bytes\n", pad
);
238 segment
->total_size
+= pad
;
240 segment
->data
= segment
->padbuf
;
246 * Set us up for transferring the data digest. hdr digest
247 * is completely handled in hdr done function.
250 crypto_hash_final(segment
->hash
, segment
->digest
);
251 iscsi_tcp_segment_splice_digest(segment
,
252 recv
? segment
->recv_digest
: segment
->digest
);
258 EXPORT_SYMBOL_GPL(iscsi_tcp_segment_done
);
261 * iscsi_tcp_segment_recv - copy data to segment
262 * @tcp_conn: the iSCSI TCP connection
263 * @segment: the buffer to copy to
265 * @len: amount of data available
267 * This function copies up to @len bytes to the
268 * given buffer, and returns the number of bytes
269 * consumed, which can actually be less than @len.
271 * If hash digest is enabled, the function will update the
272 * hash while copying.
273 * Combining these two operations doesn't buy us a lot (yet),
274 * but in the future we could implement combined copy+crc,
275 * just way we do for network layer checksums.
278 iscsi_tcp_segment_recv(struct iscsi_tcp_conn
*tcp_conn
,
279 struct iscsi_segment
*segment
, const void *ptr
,
282 unsigned int copy
= 0, copied
= 0;
284 while (!iscsi_tcp_segment_done(tcp_conn
, segment
, 1, copy
)) {
286 ISCSI_DBG_TCP(tcp_conn
->iscsi_conn
,
287 "copied %d bytes\n", len
);
291 copy
= min(len
- copied
, segment
->size
- segment
->copied
);
292 ISCSI_DBG_TCP(tcp_conn
->iscsi_conn
, "copying %d\n", copy
);
293 memcpy(segment
->data
+ segment
->copied
, ptr
+ copied
, copy
);
300 iscsi_tcp_dgst_header(struct hash_desc
*hash
, const void *hdr
, size_t hdrlen
,
301 unsigned char digest
[ISCSI_DIGEST_SIZE
])
303 struct scatterlist sg
;
305 sg_init_one(&sg
, hdr
, hdrlen
);
306 crypto_hash_digest(hash
, &sg
, hdrlen
, digest
);
308 EXPORT_SYMBOL_GPL(iscsi_tcp_dgst_header
);
311 iscsi_tcp_dgst_verify(struct iscsi_tcp_conn
*tcp_conn
,
312 struct iscsi_segment
*segment
)
314 if (!segment
->digest_len
)
317 if (memcmp(segment
->recv_digest
, segment
->digest
,
318 segment
->digest_len
)) {
319 ISCSI_DBG_TCP(tcp_conn
->iscsi_conn
, "digest mismatch\n");
327 * Helper function to set up segment buffer
330 __iscsi_segment_init(struct iscsi_segment
*segment
, size_t size
,
331 iscsi_segment_done_fn_t
*done
, struct hash_desc
*hash
)
333 memset(segment
, 0, sizeof(*segment
));
334 segment
->total_size
= size
;
335 segment
->done
= done
;
338 segment
->hash
= hash
;
339 crypto_hash_init(hash
);
344 iscsi_segment_init_linear(struct iscsi_segment
*segment
, void *data
,
345 size_t size
, iscsi_segment_done_fn_t
*done
,
346 struct hash_desc
*hash
)
348 __iscsi_segment_init(segment
, size
, done
, hash
);
349 segment
->data
= data
;
350 segment
->size
= size
;
352 EXPORT_SYMBOL_GPL(iscsi_segment_init_linear
);
355 iscsi_segment_seek_sg(struct iscsi_segment
*segment
,
356 struct scatterlist
*sg_list
, unsigned int sg_count
,
357 unsigned int offset
, size_t size
,
358 iscsi_segment_done_fn_t
*done
, struct hash_desc
*hash
)
360 struct scatterlist
*sg
;
363 __iscsi_segment_init(segment
, size
, done
, hash
);
364 for_each_sg(sg_list
, sg
, sg_count
, i
) {
365 if (offset
< sg
->length
) {
366 iscsi_tcp_segment_init_sg(segment
, sg
, offset
);
369 offset
-= sg
->length
;
372 return ISCSI_ERR_DATA_OFFSET
;
374 EXPORT_SYMBOL_GPL(iscsi_segment_seek_sg
);
377 * iscsi_tcp_hdr_recv_prep - prep segment for hdr reception
378 * @tcp_conn: iscsi connection to prep for
380 * This function always passes NULL for the hash argument, because when this
381 * function is called we do not yet know the final size of the header and want
382 * to delay the digest processing until we know that.
384 void iscsi_tcp_hdr_recv_prep(struct iscsi_tcp_conn
*tcp_conn
)
386 ISCSI_DBG_TCP(tcp_conn
->iscsi_conn
,
387 "(%s)\n", tcp_conn
->iscsi_conn
->hdrdgst_en
?
388 "digest enabled" : "digest disabled");
389 iscsi_segment_init_linear(&tcp_conn
->in
.segment
,
390 tcp_conn
->in
.hdr_buf
, sizeof(struct iscsi_hdr
),
391 iscsi_tcp_hdr_recv_done
, NULL
);
393 EXPORT_SYMBOL_GPL(iscsi_tcp_hdr_recv_prep
);
396 * Handle incoming reply to any other type of command
399 iscsi_tcp_data_recv_done(struct iscsi_tcp_conn
*tcp_conn
,
400 struct iscsi_segment
*segment
)
402 struct iscsi_conn
*conn
= tcp_conn
->iscsi_conn
;
405 if (!iscsi_tcp_dgst_verify(tcp_conn
, segment
))
406 return ISCSI_ERR_DATA_DGST
;
408 rc
= iscsi_complete_pdu(conn
, tcp_conn
->in
.hdr
,
409 conn
->data
, tcp_conn
->in
.datalen
);
413 iscsi_tcp_hdr_recv_prep(tcp_conn
);
418 iscsi_tcp_data_recv_prep(struct iscsi_tcp_conn
*tcp_conn
)
420 struct iscsi_conn
*conn
= tcp_conn
->iscsi_conn
;
421 struct hash_desc
*rx_hash
= NULL
;
423 if (conn
->datadgst_en
&
424 !(conn
->session
->tt
->caps
& CAP_DIGEST_OFFLOAD
))
425 rx_hash
= tcp_conn
->rx_hash
;
427 iscsi_segment_init_linear(&tcp_conn
->in
.segment
,
428 conn
->data
, tcp_conn
->in
.datalen
,
429 iscsi_tcp_data_recv_done
, rx_hash
);
433 * iscsi_tcp_cleanup_task - free tcp_task resources
436 * must be called with session lock
438 void iscsi_tcp_cleanup_task(struct iscsi_task
*task
)
440 struct iscsi_tcp_task
*tcp_task
= task
->dd_data
;
441 struct iscsi_r2t_info
*r2t
;
443 /* nothing to do for mgmt */
447 /* flush task's r2t queues */
448 while (kfifo_out(&tcp_task
->r2tqueue
, (void*)&r2t
, sizeof(void*))) {
449 kfifo_in(&tcp_task
->r2tpool
.queue
, (void*)&r2t
,
451 ISCSI_DBG_TCP(task
->conn
, "pending r2t dropped\n");
456 kfifo_in(&tcp_task
->r2tpool
.queue
, (void*)&r2t
,
458 tcp_task
->r2t
= NULL
;
461 EXPORT_SYMBOL_GPL(iscsi_tcp_cleanup_task
);
464 * iscsi_tcp_data_in - SCSI Data-In Response processing
465 * @conn: iscsi connection
466 * @task: scsi command task
468 static int iscsi_tcp_data_in(struct iscsi_conn
*conn
, struct iscsi_task
*task
)
470 struct iscsi_tcp_conn
*tcp_conn
= conn
->dd_data
;
471 struct iscsi_tcp_task
*tcp_task
= task
->dd_data
;
472 struct iscsi_data_rsp
*rhdr
= (struct iscsi_data_rsp
*)tcp_conn
->in
.hdr
;
473 int datasn
= be32_to_cpu(rhdr
->datasn
);
474 unsigned total_in_length
= scsi_in(task
->sc
)->length
;
477 * lib iscsi will update this in the completion handling if there
480 if (!(rhdr
->flags
& ISCSI_FLAG_DATA_STATUS
))
481 iscsi_update_cmdsn(conn
->session
, (struct iscsi_nopin
*)rhdr
);
483 if (tcp_conn
->in
.datalen
== 0)
486 if (tcp_task
->exp_datasn
!= datasn
) {
487 ISCSI_DBG_TCP(conn
, "task->exp_datasn(%d) != rhdr->datasn(%d)"
488 "\n", tcp_task
->exp_datasn
, datasn
);
489 return ISCSI_ERR_DATASN
;
492 tcp_task
->exp_datasn
++;
494 tcp_task
->data_offset
= be32_to_cpu(rhdr
->offset
);
495 if (tcp_task
->data_offset
+ tcp_conn
->in
.datalen
> total_in_length
) {
496 ISCSI_DBG_TCP(conn
, "data_offset(%d) + data_len(%d) > "
497 "total_length_in(%d)\n", tcp_task
->data_offset
,
498 tcp_conn
->in
.datalen
, total_in_length
);
499 return ISCSI_ERR_DATA_OFFSET
;
502 conn
->datain_pdus_cnt
++;
507 * iscsi_tcp_r2t_rsp - iSCSI R2T Response processing
508 * @conn: iscsi connection
509 * @task: scsi command task
511 static int iscsi_tcp_r2t_rsp(struct iscsi_conn
*conn
, struct iscsi_task
*task
)
513 struct iscsi_session
*session
= conn
->session
;
514 struct iscsi_tcp_task
*tcp_task
= task
->dd_data
;
515 struct iscsi_tcp_conn
*tcp_conn
= conn
->dd_data
;
516 struct iscsi_r2t_rsp
*rhdr
= (struct iscsi_r2t_rsp
*)tcp_conn
->in
.hdr
;
517 struct iscsi_r2t_info
*r2t
;
518 int r2tsn
= be32_to_cpu(rhdr
->r2tsn
);
521 if (tcp_conn
->in
.datalen
) {
522 iscsi_conn_printk(KERN_ERR
, conn
,
523 "invalid R2t with datalen %d\n",
524 tcp_conn
->in
.datalen
);
525 return ISCSI_ERR_DATALEN
;
528 if (tcp_task
->exp_datasn
!= r2tsn
){
529 ISCSI_DBG_TCP(conn
, "task->exp_datasn(%d) != rhdr->r2tsn(%d)\n",
530 tcp_task
->exp_datasn
, r2tsn
);
531 return ISCSI_ERR_R2TSN
;
534 /* fill-in new R2T associated with the task */
535 iscsi_update_cmdsn(session
, (struct iscsi_nopin
*)rhdr
);
537 if (!task
->sc
|| session
->state
!= ISCSI_STATE_LOGGED_IN
) {
538 iscsi_conn_printk(KERN_INFO
, conn
,
539 "dropping R2T itt %d in recovery.\n",
544 rc
= kfifo_out(&tcp_task
->r2tpool
.queue
, (void*)&r2t
, sizeof(void*));
546 iscsi_conn_printk(KERN_ERR
, conn
, "Could not allocate R2T. "
547 "Target has sent more R2Ts than it "
548 "negotiated for or driver has has leaked.\n");
549 return ISCSI_ERR_PROTO
;
552 r2t
->exp_statsn
= rhdr
->statsn
;
553 r2t
->data_length
= be32_to_cpu(rhdr
->data_length
);
554 if (r2t
->data_length
== 0) {
555 iscsi_conn_printk(KERN_ERR
, conn
,
556 "invalid R2T with zero data len\n");
557 kfifo_in(&tcp_task
->r2tpool
.queue
, (void*)&r2t
,
559 return ISCSI_ERR_DATALEN
;
562 if (r2t
->data_length
> session
->max_burst
)
563 ISCSI_DBG_TCP(conn
, "invalid R2T with data len %u and max "
564 "burst %u. Attempting to execute request.\n",
565 r2t
->data_length
, session
->max_burst
);
567 r2t
->data_offset
= be32_to_cpu(rhdr
->data_offset
);
568 if (r2t
->data_offset
+ r2t
->data_length
> scsi_out(task
->sc
)->length
) {
569 iscsi_conn_printk(KERN_ERR
, conn
,
570 "invalid R2T with data len %u at offset %u "
571 "and total length %d\n", r2t
->data_length
,
572 r2t
->data_offset
, scsi_out(task
->sc
)->length
);
573 kfifo_in(&tcp_task
->r2tpool
.queue
, (void*)&r2t
,
575 return ISCSI_ERR_DATALEN
;
578 r2t
->ttt
= rhdr
->ttt
; /* no flip */
582 tcp_task
->exp_datasn
= r2tsn
+ 1;
583 kfifo_in(&tcp_task
->r2tqueue
, (void*)&r2t
, sizeof(void*));
584 conn
->r2t_pdus_cnt
++;
586 iscsi_requeue_task(task
);
591 * Handle incoming reply to DataIn command
594 iscsi_tcp_process_data_in(struct iscsi_tcp_conn
*tcp_conn
,
595 struct iscsi_segment
*segment
)
597 struct iscsi_conn
*conn
= tcp_conn
->iscsi_conn
;
598 struct iscsi_hdr
*hdr
= tcp_conn
->in
.hdr
;
601 if (!iscsi_tcp_dgst_verify(tcp_conn
, segment
))
602 return ISCSI_ERR_DATA_DGST
;
604 /* check for non-exceptional status */
605 if (hdr
->flags
& ISCSI_FLAG_DATA_STATUS
) {
606 rc
= iscsi_complete_pdu(conn
, tcp_conn
->in
.hdr
, NULL
, 0);
611 iscsi_tcp_hdr_recv_prep(tcp_conn
);
616 * iscsi_tcp_hdr_dissect - process PDU header
617 * @conn: iSCSI connection
620 * This function analyzes the header of the PDU received,
621 * and performs several sanity checks. If the PDU is accompanied
622 * by data, the receive buffer is set up to copy the incoming data
623 * to the correct location.
626 iscsi_tcp_hdr_dissect(struct iscsi_conn
*conn
, struct iscsi_hdr
*hdr
)
628 int rc
= 0, opcode
, ahslen
;
629 struct iscsi_tcp_conn
*tcp_conn
= conn
->dd_data
;
630 struct iscsi_task
*task
;
632 /* verify PDU length */
633 tcp_conn
->in
.datalen
= ntoh24(hdr
->dlength
);
634 if (tcp_conn
->in
.datalen
> conn
->max_recv_dlength
) {
635 iscsi_conn_printk(KERN_ERR
, conn
,
636 "iscsi_tcp: datalen %d > %d\n",
637 tcp_conn
->in
.datalen
, conn
->max_recv_dlength
);
638 return ISCSI_ERR_DATALEN
;
641 /* Additional header segments. So far, we don't
642 * process additional headers.
644 ahslen
= hdr
->hlength
<< 2;
646 opcode
= hdr
->opcode
& ISCSI_OPCODE_MASK
;
647 /* verify itt (itt encoding: age+cid+itt) */
648 rc
= iscsi_verify_itt(conn
, hdr
->itt
);
652 ISCSI_DBG_TCP(conn
, "opcode 0x%x ahslen %d datalen %d\n",
653 opcode
, ahslen
, tcp_conn
->in
.datalen
);
656 case ISCSI_OP_SCSI_DATA_IN
:
657 spin_lock(&conn
->session
->lock
);
658 task
= iscsi_itt_to_ctask(conn
, hdr
->itt
);
660 rc
= ISCSI_ERR_BAD_ITT
;
662 rc
= iscsi_tcp_data_in(conn
, task
);
664 spin_unlock(&conn
->session
->lock
);
668 if (tcp_conn
->in
.datalen
) {
669 struct iscsi_tcp_task
*tcp_task
= task
->dd_data
;
670 struct hash_desc
*rx_hash
= NULL
;
671 struct scsi_data_buffer
*sdb
= scsi_in(task
->sc
);
674 * Setup copy of Data-In into the Scsi_Cmnd
676 * We set up the iscsi_segment to point to the next
677 * scatterlist entry to copy to. As we go along,
678 * we move on to the next scatterlist entry and
679 * update the digest per-entry.
681 if (conn
->datadgst_en
&&
682 !(conn
->session
->tt
->caps
& CAP_DIGEST_OFFLOAD
))
683 rx_hash
= tcp_conn
->rx_hash
;
685 ISCSI_DBG_TCP(conn
, "iscsi_tcp_begin_data_in( "
686 "offset=%d, datalen=%d)\n",
687 tcp_task
->data_offset
,
688 tcp_conn
->in
.datalen
);
689 task
->last_xfer
= jiffies
;
690 rc
= iscsi_segment_seek_sg(&tcp_conn
->in
.segment
,
693 tcp_task
->data_offset
,
694 tcp_conn
->in
.datalen
,
695 iscsi_tcp_process_data_in
,
697 spin_unlock(&conn
->session
->lock
);
700 rc
= __iscsi_complete_pdu(conn
, hdr
, NULL
, 0);
701 spin_unlock(&conn
->session
->lock
);
703 case ISCSI_OP_SCSI_CMD_RSP
:
704 if (tcp_conn
->in
.datalen
) {
705 iscsi_tcp_data_recv_prep(tcp_conn
);
708 rc
= iscsi_complete_pdu(conn
, hdr
, NULL
, 0);
711 spin_lock(&conn
->session
->lock
);
712 task
= iscsi_itt_to_ctask(conn
, hdr
->itt
);
714 rc
= ISCSI_ERR_BAD_ITT
;
716 rc
= ISCSI_ERR_AHSLEN
;
717 else if (task
->sc
->sc_data_direction
== DMA_TO_DEVICE
) {
718 task
->last_xfer
= jiffies
;
719 rc
= iscsi_tcp_r2t_rsp(conn
, task
);
721 rc
= ISCSI_ERR_PROTO
;
722 spin_unlock(&conn
->session
->lock
);
724 case ISCSI_OP_LOGIN_RSP
:
725 case ISCSI_OP_TEXT_RSP
:
726 case ISCSI_OP_REJECT
:
727 case ISCSI_OP_ASYNC_EVENT
:
729 * It is possible that we could get a PDU with a buffer larger
730 * than 8K, but there are no targets that currently do this.
731 * For now we fail until we find a vendor that needs it
733 if (ISCSI_DEF_MAX_RECV_SEG_LEN
< tcp_conn
->in
.datalen
) {
734 iscsi_conn_printk(KERN_ERR
, conn
,
735 "iscsi_tcp: received buffer of "
736 "len %u but conn buffer is only %u "
738 tcp_conn
->in
.datalen
,
739 ISCSI_DEF_MAX_RECV_SEG_LEN
, opcode
);
740 rc
= ISCSI_ERR_PROTO
;
744 /* If there's data coming in with the response,
745 * receive it to the connection's buffer.
747 if (tcp_conn
->in
.datalen
) {
748 iscsi_tcp_data_recv_prep(tcp_conn
);
752 case ISCSI_OP_LOGOUT_RSP
:
753 case ISCSI_OP_NOOP_IN
:
754 case ISCSI_OP_SCSI_TMFUNC_RSP
:
755 rc
= iscsi_complete_pdu(conn
, hdr
, NULL
, 0);
758 rc
= ISCSI_ERR_BAD_OPCODE
;
763 /* Anything that comes with data should have
764 * been handled above. */
765 if (tcp_conn
->in
.datalen
)
766 return ISCSI_ERR_PROTO
;
767 iscsi_tcp_hdr_recv_prep(tcp_conn
);
774 * iscsi_tcp_hdr_recv_done - process PDU header
776 * This is the callback invoked when the PDU header has
777 * been received. If the header is followed by additional
778 * header segments, we go back for more data.
781 iscsi_tcp_hdr_recv_done(struct iscsi_tcp_conn
*tcp_conn
,
782 struct iscsi_segment
*segment
)
784 struct iscsi_conn
*conn
= tcp_conn
->iscsi_conn
;
785 struct iscsi_hdr
*hdr
;
787 /* Check if there are additional header segments
788 * *prior* to computing the digest, because we
789 * may need to go back to the caller for more.
791 hdr
= (struct iscsi_hdr
*) tcp_conn
->in
.hdr_buf
;
792 if (segment
->copied
== sizeof(struct iscsi_hdr
) && hdr
->hlength
) {
793 /* Bump the header length - the caller will
794 * just loop around and get the AHS for us, and
796 unsigned int ahslen
= hdr
->hlength
<< 2;
798 /* Make sure we don't overflow */
799 if (sizeof(*hdr
) + ahslen
> sizeof(tcp_conn
->in
.hdr_buf
))
800 return ISCSI_ERR_AHSLEN
;
802 segment
->total_size
+= ahslen
;
803 segment
->size
+= ahslen
;
807 /* We're done processing the header. See if we're doing
808 * header digests; if so, set up the recv_digest buffer
809 * and go back for more. */
810 if (conn
->hdrdgst_en
&&
811 !(conn
->session
->tt
->caps
& CAP_DIGEST_OFFLOAD
)) {
812 if (segment
->digest_len
== 0) {
814 * Even if we offload the digest processing we
815 * splice it in so we can increment the skb/segment
816 * counters in preparation for the data segment.
818 iscsi_tcp_segment_splice_digest(segment
,
819 segment
->recv_digest
);
823 iscsi_tcp_dgst_header(tcp_conn
->rx_hash
, hdr
,
824 segment
->total_copied
- ISCSI_DIGEST_SIZE
,
827 if (!iscsi_tcp_dgst_verify(tcp_conn
, segment
))
828 return ISCSI_ERR_HDR_DGST
;
831 tcp_conn
->in
.hdr
= hdr
;
832 return iscsi_tcp_hdr_dissect(conn
, hdr
);
836 * iscsi_tcp_recv_segment_is_hdr - tests if we are reading in a header
837 * @tcp_conn: iscsi tcp conn
839 * returns non zero if we are currently processing or setup to process
842 inline int iscsi_tcp_recv_segment_is_hdr(struct iscsi_tcp_conn
*tcp_conn
)
844 return tcp_conn
->in
.segment
.done
== iscsi_tcp_hdr_recv_done
;
846 EXPORT_SYMBOL_GPL(iscsi_tcp_recv_segment_is_hdr
);
849 * iscsi_tcp_recv_skb - Process skb
850 * @conn: iscsi connection
851 * @skb: network buffer with header and/or data segment
852 * @offset: offset in skb
853 * @offload: bool indicating if transfer was offloaded
855 * Will return status of transfer in status. And will return
856 * number of bytes copied.
858 int iscsi_tcp_recv_skb(struct iscsi_conn
*conn
, struct sk_buff
*skb
,
859 unsigned int offset
, bool offloaded
, int *status
)
861 struct iscsi_tcp_conn
*tcp_conn
= conn
->dd_data
;
862 struct iscsi_segment
*segment
= &tcp_conn
->in
.segment
;
863 struct skb_seq_state seq
;
864 unsigned int consumed
= 0;
867 ISCSI_DBG_TCP(conn
, "in %d bytes\n", skb
->len
- offset
);
869 * Update for each skb instead of pdu, because over slow networks a
870 * data_in's data could take a while to read in. We also want to
873 conn
->last_recv
= jiffies
;
875 if (unlikely(conn
->suspend_rx
)) {
876 ISCSI_DBG_TCP(conn
, "Rx suspended!\n");
877 *status
= ISCSI_TCP_SUSPENDED
;
882 segment
->total_copied
= segment
->total_size
;
886 skb_prepare_seq_read(skb
, offset
, skb
->len
, &seq
);
891 avail
= skb_seq_read(consumed
, &ptr
, &seq
);
893 ISCSI_DBG_TCP(conn
, "no more data avail. Consumed %d\n",
895 *status
= ISCSI_TCP_SKB_DONE
;
896 skb_abort_seq_read(&seq
);
899 BUG_ON(segment
->copied
>= segment
->size
);
901 ISCSI_DBG_TCP(conn
, "skb %p ptr=%p avail=%u\n", skb
, ptr
,
903 rc
= iscsi_tcp_segment_recv(tcp_conn
, segment
, ptr
, avail
);
907 if (segment
->total_copied
>= segment
->total_size
) {
908 skb_abort_seq_read(&seq
);
914 *status
= ISCSI_TCP_SEGMENT_DONE
;
915 ISCSI_DBG_TCP(conn
, "segment done\n");
916 rc
= segment
->done(tcp_conn
, segment
);
918 *status
= ISCSI_TCP_CONN_ERR
;
919 ISCSI_DBG_TCP(conn
, "Error receiving PDU, errno=%d\n", rc
);
920 iscsi_conn_failure(conn
, rc
);
923 /* The done() functions sets up the next segment. */
926 conn
->rxdata_octets
+= consumed
;
929 EXPORT_SYMBOL_GPL(iscsi_tcp_recv_skb
);
932 * iscsi_tcp_task_init - Initialize iSCSI SCSI_READ or SCSI_WRITE commands
933 * @conn: iscsi connection
934 * @task: scsi command task
937 int iscsi_tcp_task_init(struct iscsi_task
*task
)
939 struct iscsi_tcp_task
*tcp_task
= task
->dd_data
;
940 struct iscsi_conn
*conn
= task
->conn
;
941 struct scsi_cmnd
*sc
= task
->sc
;
946 * mgmt tasks do not have a scatterlist since they come
947 * in from the iscsi interface.
949 ISCSI_DBG_TCP(conn
, "mtask deq [itt 0x%x]\n", task
->itt
);
951 return conn
->session
->tt
->init_pdu(task
, 0, task
->data_count
);
954 BUG_ON(kfifo_len(&tcp_task
->r2tqueue
));
955 tcp_task
->exp_datasn
= 0;
957 /* Prepare PDU, optionally w/ immediate data */
958 ISCSI_DBG_TCP(conn
, "task deq [itt 0x%x imm %d unsol %d]\n",
959 task
->itt
, task
->imm_count
, task
->unsol_r2t
.data_length
);
961 err
= conn
->session
->tt
->init_pdu(task
, 0, task
->imm_count
);
967 EXPORT_SYMBOL_GPL(iscsi_tcp_task_init
);
969 static struct iscsi_r2t_info
*iscsi_tcp_get_curr_r2t(struct iscsi_task
*task
)
971 struct iscsi_session
*session
= task
->conn
->session
;
972 struct iscsi_tcp_task
*tcp_task
= task
->dd_data
;
973 struct iscsi_r2t_info
*r2t
= NULL
;
975 if (iscsi_task_has_unsol_data(task
))
976 r2t
= &task
->unsol_r2t
;
978 spin_lock_bh(&session
->lock
);
981 /* Continue with this R2T? */
982 if (r2t
->data_length
<= r2t
->sent
) {
983 ISCSI_DBG_TCP(task
->conn
,
984 " done with r2t %p\n", r2t
);
985 kfifo_in(&tcp_task
->r2tpool
.queue
,
986 (void *)&tcp_task
->r2t
,
988 tcp_task
->r2t
= r2t
= NULL
;
993 if (kfifo_out(&tcp_task
->r2tqueue
,
994 (void *)&tcp_task
->r2t
, sizeof(void *)) !=
1000 spin_unlock_bh(&session
->lock
);
1007 * iscsi_tcp_task_xmit - xmit normal PDU task
1008 * @task: iscsi command task
1010 * We're expected to return 0 when everything was transmitted successfully,
1011 * -EAGAIN if there's still data in the queue, or != 0 for any other kind
1014 int iscsi_tcp_task_xmit(struct iscsi_task
*task
)
1016 struct iscsi_conn
*conn
= task
->conn
;
1017 struct iscsi_session
*session
= conn
->session
;
1018 struct iscsi_r2t_info
*r2t
;
1022 /* Flush any pending data first. */
1023 rc
= session
->tt
->xmit_pdu(task
);
1029 if (task
->hdr
->itt
== RESERVED_ITT
)
1030 iscsi_put_task(task
);
1034 /* Are we done already? */
1035 if (task
->sc
->sc_data_direction
!= DMA_TO_DEVICE
)
1038 r2t
= iscsi_tcp_get_curr_r2t(task
);
1040 /* Waiting for more R2Ts to arrive. */
1041 ISCSI_DBG_TCP(conn
, "no R2Ts yet\n");
1045 rc
= conn
->session
->tt
->alloc_pdu(task
, ISCSI_OP_SCSI_DATA_OUT
);
1048 iscsi_prep_data_out_pdu(task
, r2t
, (struct iscsi_data
*) task
->hdr
);
1050 ISCSI_DBG_TCP(conn
, "sol dout %p [dsn %d itt 0x%x doff %d dlen %d]\n",
1051 r2t
, r2t
->datasn
- 1, task
->hdr
->itt
,
1052 r2t
->data_offset
+ r2t
->sent
, r2t
->data_count
);
1054 rc
= conn
->session
->tt
->init_pdu(task
, r2t
->data_offset
+ r2t
->sent
,
1057 iscsi_conn_failure(conn
, ISCSI_ERR_XMIT_FAILED
);
1061 r2t
->sent
+= r2t
->data_count
;
1064 EXPORT_SYMBOL_GPL(iscsi_tcp_task_xmit
);
1066 struct iscsi_cls_conn
*
1067 iscsi_tcp_conn_setup(struct iscsi_cls_session
*cls_session
, int dd_data_size
,
1071 struct iscsi_conn
*conn
;
1072 struct iscsi_cls_conn
*cls_conn
;
1073 struct iscsi_tcp_conn
*tcp_conn
;
1075 cls_conn
= iscsi_conn_setup(cls_session
, sizeof(*tcp_conn
), conn_idx
);
1078 conn
= cls_conn
->dd_data
;
1080 * due to strange issues with iser these are not set
1081 * in iscsi_conn_setup
1083 conn
->max_recv_dlength
= ISCSI_DEF_MAX_RECV_SEG_LEN
;
1085 tcp_conn
= conn
->dd_data
;
1086 tcp_conn
->iscsi_conn
= conn
;
1088 tcp_conn
->dd_data
= kzalloc(dd_data_size
, GFP_KERNEL
);
1089 if (!tcp_conn
->dd_data
) {
1090 iscsi_conn_teardown(cls_conn
);
1095 EXPORT_SYMBOL_GPL(iscsi_tcp_conn_setup
);
1097 void iscsi_tcp_conn_teardown(struct iscsi_cls_conn
*cls_conn
)
1099 struct iscsi_conn
*conn
= cls_conn
->dd_data
;
1100 struct iscsi_tcp_conn
*tcp_conn
= conn
->dd_data
;
1102 kfree(tcp_conn
->dd_data
);
1103 iscsi_conn_teardown(cls_conn
);
1105 EXPORT_SYMBOL_GPL(iscsi_tcp_conn_teardown
);
1107 int iscsi_tcp_r2tpool_alloc(struct iscsi_session
*session
)
1113 * initialize per-task: R2T pool and xmit queue
1115 for (cmd_i
= 0; cmd_i
< session
->cmds_max
; cmd_i
++) {
1116 struct iscsi_task
*task
= session
->cmds
[cmd_i
];
1117 struct iscsi_tcp_task
*tcp_task
= task
->dd_data
;
1120 * pre-allocated x2 as much r2ts to handle race when
1121 * target acks DataOut faster than we data_xmit() queues
1122 * could replenish r2tqueue.
1126 if (iscsi_pool_init(&tcp_task
->r2tpool
,
1127 session
->max_r2t
* 2, NULL
,
1128 sizeof(struct iscsi_r2t_info
))) {
1129 goto r2t_alloc_fail
;
1132 /* R2T xmit queue */
1133 if (kfifo_alloc(&tcp_task
->r2tqueue
,
1134 session
->max_r2t
* 4 * sizeof(void*), GFP_KERNEL
)) {
1135 iscsi_pool_free(&tcp_task
->r2tpool
);
1136 goto r2t_alloc_fail
;
1143 for (i
= 0; i
< cmd_i
; i
++) {
1144 struct iscsi_task
*task
= session
->cmds
[i
];
1145 struct iscsi_tcp_task
*tcp_task
= task
->dd_data
;
1147 kfifo_free(&tcp_task
->r2tqueue
);
1148 iscsi_pool_free(&tcp_task
->r2tpool
);
1152 EXPORT_SYMBOL_GPL(iscsi_tcp_r2tpool_alloc
);
1154 void iscsi_tcp_r2tpool_free(struct iscsi_session
*session
)
1158 for (i
= 0; i
< session
->cmds_max
; i
++) {
1159 struct iscsi_task
*task
= session
->cmds
[i
];
1160 struct iscsi_tcp_task
*tcp_task
= task
->dd_data
;
1162 kfifo_free(&tcp_task
->r2tqueue
);
1163 iscsi_pool_free(&tcp_task
->r2tpool
);
1166 EXPORT_SYMBOL_GPL(iscsi_tcp_r2tpool_free
);
1168 void iscsi_tcp_conn_get_stats(struct iscsi_cls_conn
*cls_conn
,
1169 struct iscsi_stats
*stats
)
1171 struct iscsi_conn
*conn
= cls_conn
->dd_data
;
1173 stats
->txdata_octets
= conn
->txdata_octets
;
1174 stats
->rxdata_octets
= conn
->rxdata_octets
;
1175 stats
->scsicmd_pdus
= conn
->scsicmd_pdus_cnt
;
1176 stats
->dataout_pdus
= conn
->dataout_pdus_cnt
;
1177 stats
->scsirsp_pdus
= conn
->scsirsp_pdus_cnt
;
1178 stats
->datain_pdus
= conn
->datain_pdus_cnt
;
1179 stats
->r2t_pdus
= conn
->r2t_pdus_cnt
;
1180 stats
->tmfcmd_pdus
= conn
->tmfcmd_pdus_cnt
;
1181 stats
->tmfrsp_pdus
= conn
->tmfrsp_pdus_cnt
;
1183 EXPORT_SYMBOL_GPL(iscsi_tcp_conn_get_stats
);