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 <crypto/hash.h>
30 #include <linux/types.h>
31 #include <linux/list.h>
32 #include <linux/inet.h>
33 #include <linux/slab.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>
41 #include <scsi/scsi_cmnd.h>
42 #include <scsi/scsi_device.h>
43 #include <scsi/scsi_host.h>
44 #include <scsi/scsi.h>
45 #include <scsi/scsi_transport_iscsi.h>
47 #include "iscsi_tcp.h"
49 MODULE_AUTHOR("Mike Christie <michaelc@cs.wisc.edu>, "
50 "Dmitry Yusupov <dmitry_yus@yahoo.com>, "
51 "Alex Aizman <itn780@yahoo.com>");
52 MODULE_DESCRIPTION("iSCSI/TCP data-path");
53 MODULE_LICENSE("GPL");
55 static int iscsi_dbg_libtcp;
56 module_param_named(debug_libiscsi_tcp, iscsi_dbg_libtcp, int,
58 MODULE_PARM_DESC(debug_libiscsi_tcp, "Turn on debugging for libiscsi_tcp "
59 "module. Set to 1 to turn on, and zero to turn off. Default "
62 #define ISCSI_DBG_TCP(_conn, dbg_fmt, arg...) \
64 if (iscsi_dbg_libtcp) \
65 iscsi_conn_printk(KERN_INFO, _conn, \
70 static int iscsi_tcp_hdr_recv_done(struct iscsi_tcp_conn *tcp_conn,
71 struct iscsi_segment *segment);
74 * Scatterlist handling: inside the iscsi_segment, we
75 * remember an index into the scatterlist, and set data/size
76 * to the current scatterlist entry. For highmem pages, we
79 * Note that the page is unmapped when we return from
80 * TCP's data_ready handler, so we may end up mapping and
81 * unmapping the same page repeatedly. The whole reason
82 * for this is that we shouldn't keep the page mapped
83 * outside the softirq.
87 * iscsi_tcp_segment_init_sg - init indicated scatterlist entry
88 * @segment: the buffer object
90 * @offset: byte offset into that sg entry
92 * This function sets up the segment so that subsequent
93 * data is copied to the indicated sg entry, at the given
97 iscsi_tcp_segment_init_sg(struct iscsi_segment *segment,
98 struct scatterlist *sg, unsigned int offset)
101 segment->sg_offset = offset;
102 segment->size = min(sg->length - offset,
103 segment->total_size - segment->total_copied);
104 segment->data = NULL;
108 * iscsi_tcp_segment_map - map the current S/G page
109 * @segment: iscsi_segment
110 * @recv: 1 if called from recv path
112 * We only need to possibly kmap data if scatter lists are being used,
113 * because the iscsi passthrough and internal IO paths will never use high
116 static void iscsi_tcp_segment_map(struct iscsi_segment *segment, int recv)
118 struct scatterlist *sg;
120 if (segment->data != NULL || !segment->sg)
124 BUG_ON(segment->sg_mapped);
125 BUG_ON(sg->length == 0);
128 * If the page count is greater than one it is ok to send
129 * to the network layer's zero copy send path. If not we
130 * have to go the slow sendmsg path. We always map for the
133 if (page_count(sg_page(sg)) >= 1 && !recv)
137 segment->atomic_mapped = true;
138 segment->sg_mapped = kmap_atomic(sg_page(sg));
140 segment->atomic_mapped = false;
141 /* the xmit path can sleep with the page mapped so use kmap */
142 segment->sg_mapped = kmap(sg_page(sg));
145 segment->data = segment->sg_mapped + sg->offset + segment->sg_offset;
148 void iscsi_tcp_segment_unmap(struct iscsi_segment *segment)
150 if (segment->sg_mapped) {
151 if (segment->atomic_mapped)
152 kunmap_atomic(segment->sg_mapped);
154 kunmap(sg_page(segment->sg));
155 segment->sg_mapped = NULL;
156 segment->data = NULL;
159 EXPORT_SYMBOL_GPL(iscsi_tcp_segment_unmap);
162 * Splice the digest buffer into the buffer
165 iscsi_tcp_segment_splice_digest(struct iscsi_segment *segment, void *digest)
167 segment->data = digest;
168 segment->digest_len = ISCSI_DIGEST_SIZE;
169 segment->total_size += ISCSI_DIGEST_SIZE;
170 segment->size = ISCSI_DIGEST_SIZE;
173 segment->hash = NULL;
177 * iscsi_tcp_segment_done - check whether the segment is complete
178 * @tcp_conn: iscsi tcp connection
179 * @segment: iscsi segment to check
180 * @recv: set to one of this is called from the recv path
181 * @copied: number of bytes copied
183 * Check if we're done receiving this segment. If the receive
184 * buffer is full but we expect more data, move on to the
185 * next entry in the scatterlist.
187 * If the amount of data we received isn't a multiple of 4,
188 * we will transparently receive the pad bytes, too.
190 * This function must be re-entrant.
192 int iscsi_tcp_segment_done(struct iscsi_tcp_conn *tcp_conn,
193 struct iscsi_segment *segment, int recv,
196 struct scatterlist sg;
199 ISCSI_DBG_TCP(tcp_conn->iscsi_conn, "copied %u %u size %u %s\n",
200 segment->copied, copied, segment->size,
201 recv ? "recv" : "xmit");
202 if (segment->hash && copied) {
204 * If a segment is kmapd we must unmap it before sending
205 * to the crypto layer since that will try to kmap it again.
207 iscsi_tcp_segment_unmap(segment);
209 if (!segment->data) {
210 sg_init_table(&sg, 1);
211 sg_set_page(&sg, sg_page(segment->sg), copied,
212 segment->copied + segment->sg_offset +
213 segment->sg->offset);
215 sg_init_one(&sg, segment->data + segment->copied,
217 ahash_request_set_crypt(segment->hash, &sg, NULL, copied);
218 crypto_ahash_update(segment->hash);
221 segment->copied += copied;
222 if (segment->copied < segment->size) {
223 iscsi_tcp_segment_map(segment, recv);
227 segment->total_copied += segment->copied;
231 /* Unmap the current scatterlist page, if there is one. */
232 iscsi_tcp_segment_unmap(segment);
234 /* Do we have more scatterlist entries? */
235 ISCSI_DBG_TCP(tcp_conn->iscsi_conn, "total copied %u total size %u\n",
236 segment->total_copied, segment->total_size);
237 if (segment->total_copied < segment->total_size) {
238 /* Proceed to the next entry in the scatterlist. */
239 iscsi_tcp_segment_init_sg(segment, sg_next(segment->sg),
241 iscsi_tcp_segment_map(segment, recv);
242 BUG_ON(segment->size == 0);
246 /* Do we need to handle padding? */
247 if (!(tcp_conn->iscsi_conn->session->tt->caps & CAP_PADDING_OFFLOAD)) {
248 pad = iscsi_padding(segment->total_copied);
250 ISCSI_DBG_TCP(tcp_conn->iscsi_conn,
251 "consume %d pad bytes\n", pad);
252 segment->total_size += pad;
254 segment->data = segment->padbuf;
260 * Set us up for transferring the data digest. hdr digest
261 * is completely handled in hdr done function.
264 ahash_request_set_crypt(segment->hash, NULL,
266 crypto_ahash_final(segment->hash);
267 iscsi_tcp_segment_splice_digest(segment,
268 recv ? segment->recv_digest : segment->digest);
274 EXPORT_SYMBOL_GPL(iscsi_tcp_segment_done);
277 * iscsi_tcp_segment_recv - copy data to segment
278 * @tcp_conn: the iSCSI TCP connection
279 * @segment: the buffer to copy to
281 * @len: amount of data available
283 * This function copies up to @len bytes to the
284 * given buffer, and returns the number of bytes
285 * consumed, which can actually be less than @len.
287 * If hash digest is enabled, the function will update the
288 * hash while copying.
289 * Combining these two operations doesn't buy us a lot (yet),
290 * but in the future we could implement combined copy+crc,
291 * just way we do for network layer checksums.
294 iscsi_tcp_segment_recv(struct iscsi_tcp_conn *tcp_conn,
295 struct iscsi_segment *segment, const void *ptr,
298 unsigned int copy = 0, copied = 0;
300 while (!iscsi_tcp_segment_done(tcp_conn, segment, 1, copy)) {
302 ISCSI_DBG_TCP(tcp_conn->iscsi_conn,
303 "copied %d bytes\n", len);
307 copy = min(len - copied, segment->size - segment->copied);
308 ISCSI_DBG_TCP(tcp_conn->iscsi_conn, "copying %d\n", copy);
309 memcpy(segment->data + segment->copied, ptr + copied, copy);
316 iscsi_tcp_dgst_header(struct ahash_request *hash, const void *hdr,
317 size_t hdrlen, unsigned char digest[ISCSI_DIGEST_SIZE])
319 struct scatterlist sg;
321 sg_init_one(&sg, hdr, hdrlen);
322 ahash_request_set_crypt(hash, &sg, digest, hdrlen);
323 crypto_ahash_digest(hash);
325 EXPORT_SYMBOL_GPL(iscsi_tcp_dgst_header);
328 iscsi_tcp_dgst_verify(struct iscsi_tcp_conn *tcp_conn,
329 struct iscsi_segment *segment)
331 if (!segment->digest_len)
334 if (memcmp(segment->recv_digest, segment->digest,
335 segment->digest_len)) {
336 ISCSI_DBG_TCP(tcp_conn->iscsi_conn, "digest mismatch\n");
344 * Helper function to set up segment buffer
347 __iscsi_segment_init(struct iscsi_segment *segment, size_t size,
348 iscsi_segment_done_fn_t *done, struct ahash_request *hash)
350 memset(segment, 0, sizeof(*segment));
351 segment->total_size = size;
352 segment->done = done;
355 segment->hash = hash;
356 crypto_ahash_init(hash);
361 iscsi_segment_init_linear(struct iscsi_segment *segment, void *data,
362 size_t size, iscsi_segment_done_fn_t *done,
363 struct ahash_request *hash)
365 __iscsi_segment_init(segment, size, done, hash);
366 segment->data = data;
367 segment->size = size;
369 EXPORT_SYMBOL_GPL(iscsi_segment_init_linear);
372 iscsi_segment_seek_sg(struct iscsi_segment *segment,
373 struct scatterlist *sg_list, unsigned int sg_count,
374 unsigned int offset, size_t size,
375 iscsi_segment_done_fn_t *done,
376 struct ahash_request *hash)
378 struct scatterlist *sg;
381 __iscsi_segment_init(segment, size, done, hash);
382 for_each_sg(sg_list, sg, sg_count, i) {
383 if (offset < sg->length) {
384 iscsi_tcp_segment_init_sg(segment, sg, offset);
387 offset -= sg->length;
390 return ISCSI_ERR_DATA_OFFSET;
392 EXPORT_SYMBOL_GPL(iscsi_segment_seek_sg);
395 * iscsi_tcp_hdr_recv_prep - prep segment for hdr reception
396 * @tcp_conn: iscsi connection to prep for
398 * This function always passes NULL for the hash argument, because when this
399 * function is called we do not yet know the final size of the header and want
400 * to delay the digest processing until we know that.
402 void iscsi_tcp_hdr_recv_prep(struct iscsi_tcp_conn *tcp_conn)
404 ISCSI_DBG_TCP(tcp_conn->iscsi_conn,
405 "(%s)\n", tcp_conn->iscsi_conn->hdrdgst_en ?
406 "digest enabled" : "digest disabled");
407 iscsi_segment_init_linear(&tcp_conn->in.segment,
408 tcp_conn->in.hdr_buf, sizeof(struct iscsi_hdr),
409 iscsi_tcp_hdr_recv_done, NULL);
411 EXPORT_SYMBOL_GPL(iscsi_tcp_hdr_recv_prep);
414 * Handle incoming reply to any other type of command
417 iscsi_tcp_data_recv_done(struct iscsi_tcp_conn *tcp_conn,
418 struct iscsi_segment *segment)
420 struct iscsi_conn *conn = tcp_conn->iscsi_conn;
423 if (!iscsi_tcp_dgst_verify(tcp_conn, segment))
424 return ISCSI_ERR_DATA_DGST;
426 rc = iscsi_complete_pdu(conn, tcp_conn->in.hdr,
427 conn->data, tcp_conn->in.datalen);
431 iscsi_tcp_hdr_recv_prep(tcp_conn);
436 iscsi_tcp_data_recv_prep(struct iscsi_tcp_conn *tcp_conn)
438 struct iscsi_conn *conn = tcp_conn->iscsi_conn;
439 struct ahash_request *rx_hash = NULL;
441 if (conn->datadgst_en &&
442 !(conn->session->tt->caps & CAP_DIGEST_OFFLOAD))
443 rx_hash = tcp_conn->rx_hash;
445 iscsi_segment_init_linear(&tcp_conn->in.segment,
446 conn->data, tcp_conn->in.datalen,
447 iscsi_tcp_data_recv_done, rx_hash);
451 * iscsi_tcp_cleanup_task - free tcp_task resources
454 * must be called with session back_lock
456 void iscsi_tcp_cleanup_task(struct iscsi_task *task)
458 struct iscsi_tcp_task *tcp_task = task->dd_data;
459 struct iscsi_r2t_info *r2t;
461 /* nothing to do for mgmt */
465 spin_lock_bh(&tcp_task->queue2pool);
466 /* flush task's r2t queues */
467 while (kfifo_out(&tcp_task->r2tqueue, (void*)&r2t, sizeof(void*))) {
468 kfifo_in(&tcp_task->r2tpool.queue, (void*)&r2t,
470 ISCSI_DBG_TCP(task->conn, "pending r2t dropped\n");
475 kfifo_in(&tcp_task->r2tpool.queue, (void*)&r2t,
477 tcp_task->r2t = NULL;
479 spin_unlock_bh(&tcp_task->queue2pool);
481 EXPORT_SYMBOL_GPL(iscsi_tcp_cleanup_task);
484 * iscsi_tcp_data_in - SCSI Data-In Response processing
485 * @conn: iscsi connection
486 * @task: scsi command task
488 static int iscsi_tcp_data_in(struct iscsi_conn *conn, struct iscsi_task *task)
490 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
491 struct iscsi_tcp_task *tcp_task = task->dd_data;
492 struct iscsi_data_rsp *rhdr = (struct iscsi_data_rsp *)tcp_conn->in.hdr;
493 int datasn = be32_to_cpu(rhdr->datasn);
494 unsigned total_in_length = scsi_in(task->sc)->length;
497 * lib iscsi will update this in the completion handling if there
500 if (!(rhdr->flags & ISCSI_FLAG_DATA_STATUS))
501 iscsi_update_cmdsn(conn->session, (struct iscsi_nopin*)rhdr);
503 if (tcp_conn->in.datalen == 0)
506 if (tcp_task->exp_datasn != datasn) {
507 ISCSI_DBG_TCP(conn, "task->exp_datasn(%d) != rhdr->datasn(%d)"
508 "\n", tcp_task->exp_datasn, datasn);
509 return ISCSI_ERR_DATASN;
512 tcp_task->exp_datasn++;
514 tcp_task->data_offset = be32_to_cpu(rhdr->offset);
515 if (tcp_task->data_offset + tcp_conn->in.datalen > total_in_length) {
516 ISCSI_DBG_TCP(conn, "data_offset(%d) + data_len(%d) > "
517 "total_length_in(%d)\n", tcp_task->data_offset,
518 tcp_conn->in.datalen, total_in_length);
519 return ISCSI_ERR_DATA_OFFSET;
522 conn->datain_pdus_cnt++;
527 * iscsi_tcp_r2t_rsp - iSCSI R2T Response processing
528 * @conn: iscsi connection
529 * @task: scsi command task
531 static int iscsi_tcp_r2t_rsp(struct iscsi_conn *conn, struct iscsi_task *task)
533 struct iscsi_session *session = conn->session;
534 struct iscsi_tcp_task *tcp_task = task->dd_data;
535 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
536 struct iscsi_r2t_rsp *rhdr = (struct iscsi_r2t_rsp *)tcp_conn->in.hdr;
537 struct iscsi_r2t_info *r2t;
538 int r2tsn = be32_to_cpu(rhdr->r2tsn);
543 if (tcp_conn->in.datalen) {
544 iscsi_conn_printk(KERN_ERR, conn,
545 "invalid R2t with datalen %d\n",
546 tcp_conn->in.datalen);
547 return ISCSI_ERR_DATALEN;
550 if (tcp_task->exp_datasn != r2tsn){
551 ISCSI_DBG_TCP(conn, "task->exp_datasn(%d) != rhdr->r2tsn(%d)\n",
552 tcp_task->exp_datasn, r2tsn);
553 return ISCSI_ERR_R2TSN;
556 /* fill-in new R2T associated with the task */
557 iscsi_update_cmdsn(session, (struct iscsi_nopin*)rhdr);
559 if (!task->sc || session->state != ISCSI_STATE_LOGGED_IN) {
560 iscsi_conn_printk(KERN_INFO, conn,
561 "dropping R2T itt %d in recovery.\n",
566 data_length = be32_to_cpu(rhdr->data_length);
567 if (data_length == 0) {
568 iscsi_conn_printk(KERN_ERR, conn,
569 "invalid R2T with zero data len\n");
570 return ISCSI_ERR_DATALEN;
573 if (data_length > session->max_burst)
574 ISCSI_DBG_TCP(conn, "invalid R2T with data len %u and max "
575 "burst %u. Attempting to execute request.\n",
576 data_length, session->max_burst);
578 data_offset = be32_to_cpu(rhdr->data_offset);
579 if (data_offset + data_length > scsi_out(task->sc)->length) {
580 iscsi_conn_printk(KERN_ERR, conn,
581 "invalid R2T with data len %u at offset %u "
582 "and total length %d\n", data_length,
583 data_offset, scsi_out(task->sc)->length);
584 return ISCSI_ERR_DATALEN;
587 spin_lock(&tcp_task->pool2queue);
588 rc = kfifo_out(&tcp_task->r2tpool.queue, (void *)&r2t, sizeof(void *));
590 iscsi_conn_printk(KERN_ERR, conn, "Could not allocate R2T. "
591 "Target has sent more R2Ts than it "
592 "negotiated for or driver has leaked.\n");
593 spin_unlock(&tcp_task->pool2queue);
594 return ISCSI_ERR_PROTO;
597 r2t->exp_statsn = rhdr->statsn;
598 r2t->data_length = data_length;
599 r2t->data_offset = data_offset;
601 r2t->ttt = rhdr->ttt; /* no flip */
605 tcp_task->exp_datasn = r2tsn + 1;
606 kfifo_in(&tcp_task->r2tqueue, (void*)&r2t, sizeof(void*));
607 conn->r2t_pdus_cnt++;
608 spin_unlock(&tcp_task->pool2queue);
610 iscsi_requeue_task(task);
615 * Handle incoming reply to DataIn command
618 iscsi_tcp_process_data_in(struct iscsi_tcp_conn *tcp_conn,
619 struct iscsi_segment *segment)
621 struct iscsi_conn *conn = tcp_conn->iscsi_conn;
622 struct iscsi_hdr *hdr = tcp_conn->in.hdr;
625 if (!iscsi_tcp_dgst_verify(tcp_conn, segment))
626 return ISCSI_ERR_DATA_DGST;
628 /* check for non-exceptional status */
629 if (hdr->flags & ISCSI_FLAG_DATA_STATUS) {
630 rc = iscsi_complete_pdu(conn, tcp_conn->in.hdr, NULL, 0);
635 iscsi_tcp_hdr_recv_prep(tcp_conn);
640 * iscsi_tcp_hdr_dissect - process PDU header
641 * @conn: iSCSI connection
644 * This function analyzes the header of the PDU received,
645 * and performs several sanity checks. If the PDU is accompanied
646 * by data, the receive buffer is set up to copy the incoming data
647 * to the correct location.
650 iscsi_tcp_hdr_dissect(struct iscsi_conn *conn, struct iscsi_hdr *hdr)
652 int rc = 0, opcode, ahslen;
653 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
654 struct iscsi_task *task;
656 /* verify PDU length */
657 tcp_conn->in.datalen = ntoh24(hdr->dlength);
658 if (tcp_conn->in.datalen > conn->max_recv_dlength) {
659 iscsi_conn_printk(KERN_ERR, conn,
660 "iscsi_tcp: datalen %d > %d\n",
661 tcp_conn->in.datalen, conn->max_recv_dlength);
662 return ISCSI_ERR_DATALEN;
665 /* Additional header segments. So far, we don't
666 * process additional headers.
668 ahslen = hdr->hlength << 2;
670 opcode = hdr->opcode & ISCSI_OPCODE_MASK;
671 /* verify itt (itt encoding: age+cid+itt) */
672 rc = iscsi_verify_itt(conn, hdr->itt);
676 ISCSI_DBG_TCP(conn, "opcode 0x%x ahslen %d datalen %d\n",
677 opcode, ahslen, tcp_conn->in.datalen);
680 case ISCSI_OP_SCSI_DATA_IN:
681 spin_lock(&conn->session->back_lock);
682 task = iscsi_itt_to_ctask(conn, hdr->itt);
684 rc = ISCSI_ERR_BAD_ITT;
686 rc = iscsi_tcp_data_in(conn, task);
688 spin_unlock(&conn->session->back_lock);
692 if (tcp_conn->in.datalen) {
693 struct iscsi_tcp_task *tcp_task = task->dd_data;
694 struct ahash_request *rx_hash = NULL;
695 struct scsi_data_buffer *sdb = scsi_in(task->sc);
698 * Setup copy of Data-In into the Scsi_Cmnd
700 * We set up the iscsi_segment to point to the next
701 * scatterlist entry to copy to. As we go along,
702 * we move on to the next scatterlist entry and
703 * update the digest per-entry.
705 if (conn->datadgst_en &&
706 !(conn->session->tt->caps & CAP_DIGEST_OFFLOAD))
707 rx_hash = tcp_conn->rx_hash;
709 ISCSI_DBG_TCP(conn, "iscsi_tcp_begin_data_in( "
710 "offset=%d, datalen=%d)\n",
711 tcp_task->data_offset,
712 tcp_conn->in.datalen);
713 task->last_xfer = jiffies;
714 rc = iscsi_segment_seek_sg(&tcp_conn->in.segment,
717 tcp_task->data_offset,
718 tcp_conn->in.datalen,
719 iscsi_tcp_process_data_in,
721 spin_unlock(&conn->session->back_lock);
724 rc = __iscsi_complete_pdu(conn, hdr, NULL, 0);
725 spin_unlock(&conn->session->back_lock);
727 case ISCSI_OP_SCSI_CMD_RSP:
728 if (tcp_conn->in.datalen) {
729 iscsi_tcp_data_recv_prep(tcp_conn);
732 rc = iscsi_complete_pdu(conn, hdr, NULL, 0);
735 spin_lock(&conn->session->back_lock);
736 task = iscsi_itt_to_ctask(conn, hdr->itt);
737 spin_unlock(&conn->session->back_lock);
739 rc = ISCSI_ERR_BAD_ITT;
741 rc = ISCSI_ERR_AHSLEN;
742 else if (task->sc->sc_data_direction == DMA_TO_DEVICE) {
743 task->last_xfer = jiffies;
744 spin_lock(&conn->session->frwd_lock);
745 rc = iscsi_tcp_r2t_rsp(conn, task);
746 spin_unlock(&conn->session->frwd_lock);
748 rc = ISCSI_ERR_PROTO;
750 case ISCSI_OP_LOGIN_RSP:
751 case ISCSI_OP_TEXT_RSP:
752 case ISCSI_OP_REJECT:
753 case ISCSI_OP_ASYNC_EVENT:
755 * It is possible that we could get a PDU with a buffer larger
756 * than 8K, but there are no targets that currently do this.
757 * For now we fail until we find a vendor that needs it
759 if (ISCSI_DEF_MAX_RECV_SEG_LEN < tcp_conn->in.datalen) {
760 iscsi_conn_printk(KERN_ERR, conn,
761 "iscsi_tcp: received buffer of "
762 "len %u but conn buffer is only %u "
764 tcp_conn->in.datalen,
765 ISCSI_DEF_MAX_RECV_SEG_LEN, opcode);
766 rc = ISCSI_ERR_PROTO;
770 /* If there's data coming in with the response,
771 * receive it to the connection's buffer.
773 if (tcp_conn->in.datalen) {
774 iscsi_tcp_data_recv_prep(tcp_conn);
778 case ISCSI_OP_LOGOUT_RSP:
779 case ISCSI_OP_NOOP_IN:
780 case ISCSI_OP_SCSI_TMFUNC_RSP:
781 rc = iscsi_complete_pdu(conn, hdr, NULL, 0);
784 rc = ISCSI_ERR_BAD_OPCODE;
789 /* Anything that comes with data should have
790 * been handled above. */
791 if (tcp_conn->in.datalen)
792 return ISCSI_ERR_PROTO;
793 iscsi_tcp_hdr_recv_prep(tcp_conn);
800 * iscsi_tcp_hdr_recv_done - process PDU header
802 * This is the callback invoked when the PDU header has
803 * been received. If the header is followed by additional
804 * header segments, we go back for more data.
807 iscsi_tcp_hdr_recv_done(struct iscsi_tcp_conn *tcp_conn,
808 struct iscsi_segment *segment)
810 struct iscsi_conn *conn = tcp_conn->iscsi_conn;
811 struct iscsi_hdr *hdr;
813 /* Check if there are additional header segments
814 * *prior* to computing the digest, because we
815 * may need to go back to the caller for more.
817 hdr = (struct iscsi_hdr *) tcp_conn->in.hdr_buf;
818 if (segment->copied == sizeof(struct iscsi_hdr) && hdr->hlength) {
819 /* Bump the header length - the caller will
820 * just loop around and get the AHS for us, and
822 unsigned int ahslen = hdr->hlength << 2;
824 /* Make sure we don't overflow */
825 if (sizeof(*hdr) + ahslen > sizeof(tcp_conn->in.hdr_buf))
826 return ISCSI_ERR_AHSLEN;
828 segment->total_size += ahslen;
829 segment->size += ahslen;
833 /* We're done processing the header. See if we're doing
834 * header digests; if so, set up the recv_digest buffer
835 * and go back for more. */
836 if (conn->hdrdgst_en &&
837 !(conn->session->tt->caps & CAP_DIGEST_OFFLOAD)) {
838 if (segment->digest_len == 0) {
840 * Even if we offload the digest processing we
841 * splice it in so we can increment the skb/segment
842 * counters in preparation for the data segment.
844 iscsi_tcp_segment_splice_digest(segment,
845 segment->recv_digest);
849 iscsi_tcp_dgst_header(tcp_conn->rx_hash, hdr,
850 segment->total_copied - ISCSI_DIGEST_SIZE,
853 if (!iscsi_tcp_dgst_verify(tcp_conn, segment))
854 return ISCSI_ERR_HDR_DGST;
857 tcp_conn->in.hdr = hdr;
858 return iscsi_tcp_hdr_dissect(conn, hdr);
862 * iscsi_tcp_recv_segment_is_hdr - tests if we are reading in a header
863 * @tcp_conn: iscsi tcp conn
865 * returns non zero if we are currently processing or setup to process
868 inline int iscsi_tcp_recv_segment_is_hdr(struct iscsi_tcp_conn *tcp_conn)
870 return tcp_conn->in.segment.done == iscsi_tcp_hdr_recv_done;
872 EXPORT_SYMBOL_GPL(iscsi_tcp_recv_segment_is_hdr);
875 * iscsi_tcp_recv_skb - Process skb
876 * @conn: iscsi connection
877 * @skb: network buffer with header and/or data segment
878 * @offset: offset in skb
879 * @offload: bool indicating if transfer was offloaded
881 * Will return status of transfer in status. And will return
882 * number of bytes copied.
884 int iscsi_tcp_recv_skb(struct iscsi_conn *conn, struct sk_buff *skb,
885 unsigned int offset, bool offloaded, int *status)
887 struct iscsi_tcp_conn *tcp_conn = conn->dd_data;
888 struct iscsi_segment *segment = &tcp_conn->in.segment;
889 struct skb_seq_state seq;
890 unsigned int consumed = 0;
893 ISCSI_DBG_TCP(conn, "in %d bytes\n", skb->len - offset);
895 * Update for each skb instead of pdu, because over slow networks a
896 * data_in's data could take a while to read in. We also want to
899 conn->last_recv = jiffies;
901 if (unlikely(conn->suspend_rx)) {
902 ISCSI_DBG_TCP(conn, "Rx suspended!\n");
903 *status = ISCSI_TCP_SUSPENDED;
908 segment->total_copied = segment->total_size;
912 skb_prepare_seq_read(skb, offset, skb->len, &seq);
917 avail = skb_seq_read(consumed, &ptr, &seq);
919 ISCSI_DBG_TCP(conn, "no more data avail. Consumed %d\n",
921 *status = ISCSI_TCP_SKB_DONE;
924 BUG_ON(segment->copied >= segment->size);
926 ISCSI_DBG_TCP(conn, "skb %p ptr=%p avail=%u\n", skb, ptr,
928 rc = iscsi_tcp_segment_recv(tcp_conn, segment, ptr, avail);
932 if (segment->total_copied >= segment->total_size) {
933 skb_abort_seq_read(&seq);
939 *status = ISCSI_TCP_SEGMENT_DONE;
940 ISCSI_DBG_TCP(conn, "segment done\n");
941 rc = segment->done(tcp_conn, segment);
943 *status = ISCSI_TCP_CONN_ERR;
944 ISCSI_DBG_TCP(conn, "Error receiving PDU, errno=%d\n", rc);
945 iscsi_conn_failure(conn, rc);
948 /* The done() functions sets up the next segment. */
951 conn->rxdata_octets += consumed;
954 EXPORT_SYMBOL_GPL(iscsi_tcp_recv_skb);
957 * iscsi_tcp_task_init - Initialize iSCSI SCSI_READ or SCSI_WRITE commands
958 * @conn: iscsi connection
959 * @task: scsi command task
962 int iscsi_tcp_task_init(struct iscsi_task *task)
964 struct iscsi_tcp_task *tcp_task = task->dd_data;
965 struct iscsi_conn *conn = task->conn;
966 struct scsi_cmnd *sc = task->sc;
971 * mgmt tasks do not have a scatterlist since they come
972 * in from the iscsi interface.
974 ISCSI_DBG_TCP(conn, "mtask deq [itt 0x%x]\n", task->itt);
976 return conn->session->tt->init_pdu(task, 0, task->data_count);
979 BUG_ON(kfifo_len(&tcp_task->r2tqueue));
980 tcp_task->exp_datasn = 0;
982 /* Prepare PDU, optionally w/ immediate data */
983 ISCSI_DBG_TCP(conn, "task deq [itt 0x%x imm %d unsol %d]\n",
984 task->itt, task->imm_count, task->unsol_r2t.data_length);
986 err = conn->session->tt->init_pdu(task, 0, task->imm_count);
992 EXPORT_SYMBOL_GPL(iscsi_tcp_task_init);
994 static struct iscsi_r2t_info *iscsi_tcp_get_curr_r2t(struct iscsi_task *task)
996 struct iscsi_tcp_task *tcp_task = task->dd_data;
997 struct iscsi_r2t_info *r2t = NULL;
999 if (iscsi_task_has_unsol_data(task))
1000 r2t = &task->unsol_r2t;
1002 spin_lock_bh(&tcp_task->queue2pool);
1003 if (tcp_task->r2t) {
1004 r2t = tcp_task->r2t;
1005 /* Continue with this R2T? */
1006 if (r2t->data_length <= r2t->sent) {
1007 ISCSI_DBG_TCP(task->conn,
1008 " done with r2t %p\n", r2t);
1009 kfifo_in(&tcp_task->r2tpool.queue,
1010 (void *)&tcp_task->r2t,
1012 tcp_task->r2t = r2t = NULL;
1017 if (kfifo_out(&tcp_task->r2tqueue,
1018 (void *)&tcp_task->r2t, sizeof(void *)) !=
1022 r2t = tcp_task->r2t;
1024 spin_unlock_bh(&tcp_task->queue2pool);
1031 * iscsi_tcp_task_xmit - xmit normal PDU task
1032 * @task: iscsi command task
1034 * We're expected to return 0 when everything was transmitted successfully,
1035 * -EAGAIN if there's still data in the queue, or != 0 for any other kind
1038 int iscsi_tcp_task_xmit(struct iscsi_task *task)
1040 struct iscsi_conn *conn = task->conn;
1041 struct iscsi_session *session = conn->session;
1042 struct iscsi_r2t_info *r2t;
1046 /* Flush any pending data first. */
1047 rc = session->tt->xmit_pdu(task);
1053 if (task->hdr->itt == RESERVED_ITT)
1054 iscsi_put_task(task);
1058 /* Are we done already? */
1059 if (task->sc->sc_data_direction != DMA_TO_DEVICE)
1062 r2t = iscsi_tcp_get_curr_r2t(task);
1064 /* Waiting for more R2Ts to arrive. */
1065 ISCSI_DBG_TCP(conn, "no R2Ts yet\n");
1069 rc = conn->session->tt->alloc_pdu(task, ISCSI_OP_SCSI_DATA_OUT);
1072 iscsi_prep_data_out_pdu(task, r2t, (struct iscsi_data *) task->hdr);
1074 ISCSI_DBG_TCP(conn, "sol dout %p [dsn %d itt 0x%x doff %d dlen %d]\n",
1075 r2t, r2t->datasn - 1, task->hdr->itt,
1076 r2t->data_offset + r2t->sent, r2t->data_count);
1078 rc = conn->session->tt->init_pdu(task, r2t->data_offset + r2t->sent,
1081 iscsi_conn_failure(conn, ISCSI_ERR_XMIT_FAILED);
1085 r2t->sent += r2t->data_count;
1088 EXPORT_SYMBOL_GPL(iscsi_tcp_task_xmit);
1090 struct iscsi_cls_conn *
1091 iscsi_tcp_conn_setup(struct iscsi_cls_session *cls_session, int dd_data_size,
1095 struct iscsi_conn *conn;
1096 struct iscsi_cls_conn *cls_conn;
1097 struct iscsi_tcp_conn *tcp_conn;
1099 cls_conn = iscsi_conn_setup(cls_session,
1100 sizeof(*tcp_conn) + dd_data_size, conn_idx);
1103 conn = cls_conn->dd_data;
1105 * due to strange issues with iser these are not set
1106 * in iscsi_conn_setup
1108 conn->max_recv_dlength = ISCSI_DEF_MAX_RECV_SEG_LEN;
1110 tcp_conn = conn->dd_data;
1111 tcp_conn->iscsi_conn = conn;
1112 tcp_conn->dd_data = conn->dd_data + sizeof(*tcp_conn);
1115 EXPORT_SYMBOL_GPL(iscsi_tcp_conn_setup);
1117 void iscsi_tcp_conn_teardown(struct iscsi_cls_conn *cls_conn)
1119 iscsi_conn_teardown(cls_conn);
1121 EXPORT_SYMBOL_GPL(iscsi_tcp_conn_teardown);
1123 int iscsi_tcp_r2tpool_alloc(struct iscsi_session *session)
1129 * initialize per-task: R2T pool and xmit queue
1131 for (cmd_i = 0; cmd_i < session->cmds_max; cmd_i++) {
1132 struct iscsi_task *task = session->cmds[cmd_i];
1133 struct iscsi_tcp_task *tcp_task = task->dd_data;
1136 * pre-allocated x2 as much r2ts to handle race when
1137 * target acks DataOut faster than we data_xmit() queues
1138 * could replenish r2tqueue.
1142 if (iscsi_pool_init(&tcp_task->r2tpool,
1143 session->max_r2t * 2, NULL,
1144 sizeof(struct iscsi_r2t_info))) {
1145 goto r2t_alloc_fail;
1148 /* R2T xmit queue */
1149 if (kfifo_alloc(&tcp_task->r2tqueue,
1150 session->max_r2t * 4 * sizeof(void*), GFP_KERNEL)) {
1151 iscsi_pool_free(&tcp_task->r2tpool);
1152 goto r2t_alloc_fail;
1154 spin_lock_init(&tcp_task->pool2queue);
1155 spin_lock_init(&tcp_task->queue2pool);
1161 for (i = 0; i < cmd_i; i++) {
1162 struct iscsi_task *task = session->cmds[i];
1163 struct iscsi_tcp_task *tcp_task = task->dd_data;
1165 kfifo_free(&tcp_task->r2tqueue);
1166 iscsi_pool_free(&tcp_task->r2tpool);
1170 EXPORT_SYMBOL_GPL(iscsi_tcp_r2tpool_alloc);
1172 void iscsi_tcp_r2tpool_free(struct iscsi_session *session)
1176 for (i = 0; i < session->cmds_max; i++) {
1177 struct iscsi_task *task = session->cmds[i];
1178 struct iscsi_tcp_task *tcp_task = task->dd_data;
1180 kfifo_free(&tcp_task->r2tqueue);
1181 iscsi_pool_free(&tcp_task->r2tpool);
1184 EXPORT_SYMBOL_GPL(iscsi_tcp_r2tpool_free);
1186 int iscsi_tcp_set_max_r2t(struct iscsi_conn *conn, char *buf)
1188 struct iscsi_session *session = conn->session;
1189 unsigned short r2ts = 0;
1191 sscanf(buf, "%hu", &r2ts);
1192 if (session->max_r2t == r2ts)
1195 if (!r2ts || !is_power_of_2(r2ts))
1198 session->max_r2t = r2ts;
1199 iscsi_tcp_r2tpool_free(session);
1200 return iscsi_tcp_r2tpool_alloc(session);
1202 EXPORT_SYMBOL_GPL(iscsi_tcp_set_max_r2t);
1204 void iscsi_tcp_conn_get_stats(struct iscsi_cls_conn *cls_conn,
1205 struct iscsi_stats *stats)
1207 struct iscsi_conn *conn = cls_conn->dd_data;
1209 stats->txdata_octets = conn->txdata_octets;
1210 stats->rxdata_octets = conn->rxdata_octets;
1211 stats->scsicmd_pdus = conn->scsicmd_pdus_cnt;
1212 stats->dataout_pdus = conn->dataout_pdus_cnt;
1213 stats->scsirsp_pdus = conn->scsirsp_pdus_cnt;
1214 stats->datain_pdus = conn->datain_pdus_cnt;
1215 stats->r2t_pdus = conn->r2t_pdus_cnt;
1216 stats->tmfcmd_pdus = conn->tmfcmd_pdus_cnt;
1217 stats->tmfrsp_pdus = conn->tmfrsp_pdus_cnt;
1219 EXPORT_SYMBOL_GPL(iscsi_tcp_conn_get_stats);