4 * Copyright (C) 2006 Red Hat, Inc. All rights reserved.
5 * Copyright (C) 2004 - 2006 Mike Christie
6 * Copyright (C) 2004 - 2005 Dmitry Yusupov
7 * Copyright (C) 2004 - 2005 Alex Aizman
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 by
12 * 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,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 #include <linux/types.h>
25 #include <linux/kfifo.h>
26 #include <linux/delay.h>
27 #include <linux/log2.h>
28 #include <asm/unaligned.h>
30 #include <scsi/scsi_cmnd.h>
31 #include <scsi/scsi_device.h>
32 #include <scsi/scsi_eh.h>
33 #include <scsi/scsi_tcq.h>
34 #include <scsi/scsi_host.h>
35 #include <scsi/scsi.h>
36 #include <scsi/iscsi_proto.h>
37 #include <scsi/scsi_transport.h>
38 #include <scsi/scsi_transport_iscsi.h>
39 #include <scsi/libiscsi.h>
41 static int iscsi_dbg_lib;
42 module_param_named(debug_libiscsi, iscsi_dbg_lib, int, S_IRUGO | S_IWUSR);
43 MODULE_PARM_DESC(debug_libiscsi, "Turn on debugging for libiscsi module. "
44 "Set to 1 to turn on, and zero to turn off. Default "
47 #define ISCSI_DBG_CONN(_conn, dbg_fmt, arg...) \
50 iscsi_conn_printk(KERN_INFO, _conn, \
55 #define ISCSI_DBG_SESSION(_session, dbg_fmt, arg...) \
58 iscsi_session_printk(KERN_INFO, _session, \
63 /* Serial Number Arithmetic, 32 bits, less than, RFC1982 */
64 #define SNA32_CHECK 2147483648UL
66 static int iscsi_sna_lt(u32 n1, u32 n2)
68 return n1 != n2 && ((n1 < n2 && (n2 - n1 < SNA32_CHECK)) ||
69 (n1 > n2 && (n2 - n1 < SNA32_CHECK)));
72 /* Serial Number Arithmetic, 32 bits, less than, RFC1982 */
73 static int iscsi_sna_lte(u32 n1, u32 n2)
75 return n1 == n2 || ((n1 < n2 && (n2 - n1 < SNA32_CHECK)) ||
76 (n1 > n2 && (n2 - n1 < SNA32_CHECK)));
79 inline void iscsi_conn_queue_work(struct iscsi_conn *conn)
81 struct Scsi_Host *shost = conn->session->host;
82 struct iscsi_host *ihost = shost_priv(shost);
84 queue_work(ihost->workq, &conn->xmitwork);
86 EXPORT_SYMBOL_GPL(iscsi_conn_queue_work);
89 iscsi_update_cmdsn(struct iscsi_session *session, struct iscsi_nopin *hdr)
91 uint32_t max_cmdsn = be32_to_cpu(hdr->max_cmdsn);
92 uint32_t exp_cmdsn = be32_to_cpu(hdr->exp_cmdsn);
95 * standard specifies this check for when to update expected and
96 * max sequence numbers
98 if (iscsi_sna_lt(max_cmdsn, exp_cmdsn - 1))
101 if (exp_cmdsn != session->exp_cmdsn &&
102 !iscsi_sna_lt(exp_cmdsn, session->exp_cmdsn))
103 session->exp_cmdsn = exp_cmdsn;
105 if (max_cmdsn != session->max_cmdsn &&
106 !iscsi_sna_lt(max_cmdsn, session->max_cmdsn)) {
107 session->max_cmdsn = max_cmdsn;
109 * if the window closed with IO queued, then kick the
112 if (!list_empty(&session->leadconn->xmitqueue) ||
113 !list_empty(&session->leadconn->mgmtqueue)) {
114 if (!(session->tt->caps & CAP_DATA_PATH_OFFLOAD))
115 iscsi_conn_queue_work(session->leadconn);
119 EXPORT_SYMBOL_GPL(iscsi_update_cmdsn);
122 * iscsi_prep_data_out_pdu - initialize Data-Out
123 * @task: scsi command task
125 * @hdr: iscsi data in pdu
128 * Initialize Data-Out within this R2T sequence and finds
129 * proper data_offset within this SCSI command.
131 * This function is called with connection lock taken.
133 void iscsi_prep_data_out_pdu(struct iscsi_task *task, struct iscsi_r2t_info *r2t,
134 struct iscsi_data *hdr)
136 struct iscsi_conn *conn = task->conn;
137 unsigned int left = r2t->data_length - r2t->sent;
139 task->hdr_len = sizeof(struct iscsi_data);
141 memset(hdr, 0, sizeof(struct iscsi_data));
143 hdr->datasn = cpu_to_be32(r2t->datasn);
145 hdr->opcode = ISCSI_OP_SCSI_DATA_OUT;
146 memcpy(hdr->lun, task->lun, sizeof(hdr->lun));
147 hdr->itt = task->hdr_itt;
148 hdr->exp_statsn = r2t->exp_statsn;
149 hdr->offset = cpu_to_be32(r2t->data_offset + r2t->sent);
150 if (left > conn->max_xmit_dlength) {
151 hton24(hdr->dlength, conn->max_xmit_dlength);
152 r2t->data_count = conn->max_xmit_dlength;
155 hton24(hdr->dlength, left);
156 r2t->data_count = left;
157 hdr->flags = ISCSI_FLAG_CMD_FINAL;
159 conn->dataout_pdus_cnt++;
161 EXPORT_SYMBOL_GPL(iscsi_prep_data_out_pdu);
163 static int iscsi_add_hdr(struct iscsi_task *task, unsigned len)
165 unsigned exp_len = task->hdr_len + len;
167 if (exp_len > task->hdr_max) {
172 WARN_ON(len & (ISCSI_PAD_LEN - 1)); /* caller must pad the AHS */
173 task->hdr_len = exp_len;
178 * make an extended cdb AHS
180 static int iscsi_prep_ecdb_ahs(struct iscsi_task *task)
182 struct scsi_cmnd *cmd = task->sc;
183 unsigned rlen, pad_len;
184 unsigned short ahslength;
185 struct iscsi_ecdb_ahdr *ecdb_ahdr;
188 ecdb_ahdr = iscsi_next_hdr(task);
189 rlen = cmd->cmd_len - ISCSI_CDB_SIZE;
191 BUG_ON(rlen > sizeof(ecdb_ahdr->ecdb));
192 ahslength = rlen + sizeof(ecdb_ahdr->reserved);
194 pad_len = iscsi_padding(rlen);
196 rc = iscsi_add_hdr(task, sizeof(ecdb_ahdr->ahslength) +
197 sizeof(ecdb_ahdr->ahstype) + ahslength + pad_len);
202 memset(&ecdb_ahdr->ecdb[rlen], 0, pad_len);
204 ecdb_ahdr->ahslength = cpu_to_be16(ahslength);
205 ecdb_ahdr->ahstype = ISCSI_AHSTYPE_CDB;
206 ecdb_ahdr->reserved = 0;
207 memcpy(ecdb_ahdr->ecdb, cmd->cmnd + ISCSI_CDB_SIZE, rlen);
209 ISCSI_DBG_SESSION(task->conn->session,
210 "iscsi_prep_ecdb_ahs: varlen_cdb_len %d "
211 "rlen %d pad_len %d ahs_length %d iscsi_headers_size "
212 "%u\n", cmd->cmd_len, rlen, pad_len, ahslength,
217 static int iscsi_prep_bidi_ahs(struct iscsi_task *task)
219 struct scsi_cmnd *sc = task->sc;
220 struct iscsi_rlength_ahdr *rlen_ahdr;
223 rlen_ahdr = iscsi_next_hdr(task);
224 rc = iscsi_add_hdr(task, sizeof(*rlen_ahdr));
228 rlen_ahdr->ahslength =
229 cpu_to_be16(sizeof(rlen_ahdr->read_length) +
230 sizeof(rlen_ahdr->reserved));
231 rlen_ahdr->ahstype = ISCSI_AHSTYPE_RLENGTH;
232 rlen_ahdr->reserved = 0;
233 rlen_ahdr->read_length = cpu_to_be32(scsi_in(sc)->length);
235 ISCSI_DBG_SESSION(task->conn->session,
236 "bidi-in rlen_ahdr->read_length(%d) "
237 "rlen_ahdr->ahslength(%d)\n",
238 be32_to_cpu(rlen_ahdr->read_length),
239 be16_to_cpu(rlen_ahdr->ahslength));
244 * iscsi_prep_scsi_cmd_pdu - prep iscsi scsi cmd pdu
247 * Prep basic iSCSI PDU fields for a scsi cmd pdu. The LLD should set
248 * fields like dlength or final based on how much data it sends
250 static int iscsi_prep_scsi_cmd_pdu(struct iscsi_task *task)
252 struct iscsi_conn *conn = task->conn;
253 struct iscsi_session *session = conn->session;
254 struct scsi_cmnd *sc = task->sc;
255 struct iscsi_cmd *hdr;
256 unsigned hdrlength, cmd_len;
260 if (conn->session->tt->alloc_pdu) {
261 rc = conn->session->tt->alloc_pdu(task, ISCSI_OP_SCSI_CMD);
265 hdr = (struct iscsi_cmd *) task->hdr;
267 memset(hdr, 0, sizeof(*hdr));
269 if (session->tt->parse_pdu_itt)
270 hdr->itt = task->hdr_itt = itt;
272 hdr->itt = task->hdr_itt = build_itt(task->itt,
273 task->conn->session->age);
275 rc = iscsi_add_hdr(task, sizeof(*hdr));
278 hdr->opcode = ISCSI_OP_SCSI_CMD;
279 hdr->flags = ISCSI_ATTR_SIMPLE;
280 int_to_scsilun(sc->device->lun, (struct scsi_lun *)hdr->lun);
281 memcpy(task->lun, hdr->lun, sizeof(task->lun));
282 hdr->cmdsn = task->cmdsn = cpu_to_be32(session->cmdsn);
284 hdr->exp_statsn = cpu_to_be32(conn->exp_statsn);
285 cmd_len = sc->cmd_len;
286 if (cmd_len < ISCSI_CDB_SIZE)
287 memset(&hdr->cdb[cmd_len], 0, ISCSI_CDB_SIZE - cmd_len);
288 else if (cmd_len > ISCSI_CDB_SIZE) {
289 rc = iscsi_prep_ecdb_ahs(task);
292 cmd_len = ISCSI_CDB_SIZE;
294 memcpy(hdr->cdb, sc->cmnd, cmd_len);
297 if (scsi_bidi_cmnd(sc)) {
298 hdr->flags |= ISCSI_FLAG_CMD_READ;
299 rc = iscsi_prep_bidi_ahs(task);
303 if (sc->sc_data_direction == DMA_TO_DEVICE) {
304 unsigned out_len = scsi_out(sc)->length;
305 struct iscsi_r2t_info *r2t = &task->unsol_r2t;
307 hdr->data_length = cpu_to_be32(out_len);
308 hdr->flags |= ISCSI_FLAG_CMD_WRITE;
312 * imm_count bytes to be sent right after
315 * unsol_count bytes(as Data-Out) to be sent
316 * without R2T ack right after
319 * r2t data_length bytes to be sent via R2T ack's
321 * pad_count bytes to be sent as zero-padding
323 memset(r2t, 0, sizeof(*r2t));
325 if (session->imm_data_en) {
326 if (out_len >= session->first_burst)
327 task->imm_count = min(session->first_burst,
328 conn->max_xmit_dlength);
330 task->imm_count = min(out_len,
331 conn->max_xmit_dlength);
332 hton24(hdr->dlength, task->imm_count);
334 zero_data(hdr->dlength);
336 if (!session->initial_r2t_en) {
337 r2t->data_length = min(session->first_burst, out_len) -
339 r2t->data_offset = task->imm_count;
340 r2t->ttt = cpu_to_be32(ISCSI_RESERVED_TAG);
341 r2t->exp_statsn = cpu_to_be32(conn->exp_statsn);
344 if (!task->unsol_r2t.data_length)
345 /* No unsolicit Data-Out's */
346 hdr->flags |= ISCSI_FLAG_CMD_FINAL;
348 hdr->flags |= ISCSI_FLAG_CMD_FINAL;
349 zero_data(hdr->dlength);
350 hdr->data_length = cpu_to_be32(scsi_in(sc)->length);
352 if (sc->sc_data_direction == DMA_FROM_DEVICE)
353 hdr->flags |= ISCSI_FLAG_CMD_READ;
356 /* calculate size of additional header segments (AHSs) */
357 hdrlength = task->hdr_len - sizeof(*hdr);
359 WARN_ON(hdrlength & (ISCSI_PAD_LEN-1));
360 hdrlength /= ISCSI_PAD_LEN;
362 WARN_ON(hdrlength >= 256);
363 hdr->hlength = hdrlength & 0xFF;
365 if (session->tt->init_task && session->tt->init_task(task))
368 task->state = ISCSI_TASK_RUNNING;
369 list_move_tail(&task->running, &conn->run_list);
371 conn->scsicmd_pdus_cnt++;
372 ISCSI_DBG_SESSION(session, "iscsi prep [%s cid %d sc %p cdb 0x%x "
373 "itt 0x%x len %d bidi_len %d cmdsn %d win %d]\n",
374 scsi_bidi_cmnd(sc) ? "bidirectional" :
375 sc->sc_data_direction == DMA_TO_DEVICE ?
376 "write" : "read", conn->id, sc, sc->cmnd[0],
377 task->itt, scsi_bufflen(sc),
378 scsi_bidi_cmnd(sc) ? scsi_in(sc)->length : 0,
380 session->max_cmdsn - session->exp_cmdsn + 1);
385 * iscsi_complete_command - finish a task
386 * @task: iscsi cmd task
388 * Must be called with session lock.
389 * This function returns the scsi command to scsi-ml or cleans
390 * up mgmt tasks then returns the task to the pool.
392 static void iscsi_complete_command(struct iscsi_task *task)
394 struct iscsi_conn *conn = task->conn;
395 struct iscsi_session *session = conn->session;
396 struct scsi_cmnd *sc = task->sc;
398 session->tt->cleanup_task(task);
399 list_del_init(&task->running);
400 task->state = ISCSI_TASK_COMPLETED;
403 if (conn->task == task)
406 * login task is preallocated so do not free
408 if (conn->login_task == task)
411 __kfifo_put(session->cmdpool.queue, (void*)&task, sizeof(void*));
413 if (conn->ping_task == task)
414 conn->ping_task = NULL;
418 /* SCSI eh reuses commands to verify us */
421 * queue command may call this to free the task, but
422 * not have setup the sc callback
429 void __iscsi_get_task(struct iscsi_task *task)
431 atomic_inc(&task->refcount);
433 EXPORT_SYMBOL_GPL(__iscsi_get_task);
435 static void __iscsi_put_task(struct iscsi_task *task)
437 if (atomic_dec_and_test(&task->refcount))
438 iscsi_complete_command(task);
441 void iscsi_put_task(struct iscsi_task *task)
443 struct iscsi_session *session = task->conn->session;
445 spin_lock_bh(&session->lock);
446 __iscsi_put_task(task);
447 spin_unlock_bh(&session->lock);
449 EXPORT_SYMBOL_GPL(iscsi_put_task);
452 * session lock must be held
454 static void fail_command(struct iscsi_conn *conn, struct iscsi_task *task,
457 struct scsi_cmnd *sc;
463 if (task->state == ISCSI_TASK_PENDING)
465 * cmd never made it to the xmit thread, so we should not count
466 * the cmd in the sequencing
468 conn->session->queued_cmdsn--;
471 if (!scsi_bidi_cmnd(sc))
472 scsi_set_resid(sc, scsi_bufflen(sc));
474 scsi_out(sc)->resid = scsi_out(sc)->length;
475 scsi_in(sc)->resid = scsi_in(sc)->length;
478 if (conn->task == task)
480 /* release ref from queuecommand */
481 __iscsi_put_task(task);
484 static int iscsi_prep_mgmt_task(struct iscsi_conn *conn,
485 struct iscsi_task *task)
487 struct iscsi_session *session = conn->session;
488 struct iscsi_hdr *hdr = task->hdr;
489 struct iscsi_nopout *nop = (struct iscsi_nopout *)hdr;
491 if (conn->session->state == ISCSI_STATE_LOGGING_OUT)
494 if (hdr->opcode != (ISCSI_OP_LOGIN | ISCSI_OP_IMMEDIATE) &&
495 hdr->opcode != (ISCSI_OP_TEXT | ISCSI_OP_IMMEDIATE))
496 nop->exp_statsn = cpu_to_be32(conn->exp_statsn);
498 * pre-format CmdSN for outgoing PDU.
500 nop->cmdsn = cpu_to_be32(session->cmdsn);
501 if (hdr->itt != RESERVED_ITT) {
503 * TODO: We always use immediate, so we never hit this.
504 * If we start to send tmfs or nops as non-immediate then
505 * we should start checking the cmdsn numbers for mgmt tasks.
507 if (conn->c_stage == ISCSI_CONN_STARTED &&
508 !(hdr->opcode & ISCSI_OP_IMMEDIATE)) {
509 session->queued_cmdsn++;
514 if (session->tt->init_task && session->tt->init_task(task))
517 if ((hdr->opcode & ISCSI_OPCODE_MASK) == ISCSI_OP_LOGOUT)
518 session->state = ISCSI_STATE_LOGGING_OUT;
520 task->state = ISCSI_TASK_RUNNING;
521 list_move_tail(&task->running, &conn->mgmt_run_list);
522 ISCSI_DBG_SESSION(session, "mgmtpdu [op 0x%x hdr->itt 0x%x "
523 "datalen %d]\n", hdr->opcode & ISCSI_OPCODE_MASK,
524 hdr->itt, task->data_count);
528 static struct iscsi_task *
529 __iscsi_conn_send_pdu(struct iscsi_conn *conn, struct iscsi_hdr *hdr,
530 char *data, uint32_t data_size)
532 struct iscsi_session *session = conn->session;
533 struct iscsi_task *task;
536 if (session->state == ISCSI_STATE_TERMINATE)
539 if (hdr->opcode == (ISCSI_OP_LOGIN | ISCSI_OP_IMMEDIATE) ||
540 hdr->opcode == (ISCSI_OP_TEXT | ISCSI_OP_IMMEDIATE))
542 * Login and Text are sent serially, in
543 * request-followed-by-response sequence.
544 * Same task can be used. Same ITT must be used.
545 * Note that login_task is preallocated at conn_create().
547 task = conn->login_task;
549 if (session->state != ISCSI_STATE_LOGGED_IN)
552 BUG_ON(conn->c_stage == ISCSI_CONN_INITIAL_STAGE);
553 BUG_ON(conn->c_stage == ISCSI_CONN_STOPPED);
555 if (!__kfifo_get(session->cmdpool.queue,
556 (void*)&task, sizeof(void*)))
560 * released in complete pdu for task we expect a response for, and
561 * released by the lld when it has transmitted the task for
562 * pdus we do not expect a response for.
564 atomic_set(&task->refcount, 1);
569 memcpy(task->data, data, data_size);
570 task->data_count = data_size;
572 task->data_count = 0;
574 if (conn->session->tt->alloc_pdu) {
575 if (conn->session->tt->alloc_pdu(task, hdr->opcode)) {
576 iscsi_conn_printk(KERN_ERR, conn, "Could not allocate "
577 "pdu for mgmt task.\n");
582 itt = task->hdr->itt;
583 task->hdr_len = sizeof(struct iscsi_hdr);
584 memcpy(task->hdr, hdr, sizeof(struct iscsi_hdr));
586 if (hdr->itt != RESERVED_ITT) {
587 if (session->tt->parse_pdu_itt)
588 task->hdr->itt = itt;
590 task->hdr->itt = build_itt(task->itt,
591 task->conn->session->age);
594 INIT_LIST_HEAD(&task->running);
595 list_add_tail(&task->running, &conn->mgmtqueue);
597 if (session->tt->caps & CAP_DATA_PATH_OFFLOAD) {
598 if (iscsi_prep_mgmt_task(conn, task))
601 if (session->tt->xmit_task(task))
605 iscsi_conn_queue_work(conn);
610 __iscsi_put_task(task);
614 if (task != conn->login_task)
615 __kfifo_put(session->cmdpool.queue, (void*)&task,
620 int iscsi_conn_send_pdu(struct iscsi_cls_conn *cls_conn, struct iscsi_hdr *hdr,
621 char *data, uint32_t data_size)
623 struct iscsi_conn *conn = cls_conn->dd_data;
624 struct iscsi_session *session = conn->session;
627 spin_lock_bh(&session->lock);
628 if (!__iscsi_conn_send_pdu(conn, hdr, data, data_size))
630 spin_unlock_bh(&session->lock);
633 EXPORT_SYMBOL_GPL(iscsi_conn_send_pdu);
636 * iscsi_cmd_rsp - SCSI Command Response processing
637 * @conn: iscsi connection
639 * @task: scsi command task
640 * @data: cmd data buffer
641 * @datalen: len of buffer
643 * iscsi_cmd_rsp sets up the scsi_cmnd fields based on the PDU and
644 * then completes the command and task.
646 static void iscsi_scsi_cmd_rsp(struct iscsi_conn *conn, struct iscsi_hdr *hdr,
647 struct iscsi_task *task, char *data,
650 struct iscsi_cmd_rsp *rhdr = (struct iscsi_cmd_rsp *)hdr;
651 struct iscsi_session *session = conn->session;
652 struct scsi_cmnd *sc = task->sc;
654 iscsi_update_cmdsn(session, (struct iscsi_nopin*)rhdr);
655 conn->exp_statsn = be32_to_cpu(rhdr->statsn) + 1;
657 sc->result = (DID_OK << 16) | rhdr->cmd_status;
659 if (rhdr->response != ISCSI_STATUS_CMD_COMPLETED) {
660 sc->result = DID_ERROR << 16;
664 if (rhdr->cmd_status == SAM_STAT_CHECK_CONDITION) {
669 iscsi_conn_printk(KERN_ERR, conn,
670 "Got CHECK_CONDITION but invalid data "
671 "buffer size of %d\n", datalen);
672 sc->result = DID_BAD_TARGET << 16;
676 senselen = get_unaligned_be16(data);
677 if (datalen < senselen)
678 goto invalid_datalen;
680 memcpy(sc->sense_buffer, data + 2,
681 min_t(uint16_t, senselen, SCSI_SENSE_BUFFERSIZE));
682 ISCSI_DBG_SESSION(session, "copied %d bytes of sense\n",
683 min_t(uint16_t, senselen,
684 SCSI_SENSE_BUFFERSIZE));
687 if (rhdr->flags & (ISCSI_FLAG_CMD_BIDI_UNDERFLOW |
688 ISCSI_FLAG_CMD_BIDI_OVERFLOW)) {
689 int res_count = be32_to_cpu(rhdr->bi_residual_count);
691 if (scsi_bidi_cmnd(sc) && res_count > 0 &&
692 (rhdr->flags & ISCSI_FLAG_CMD_BIDI_OVERFLOW ||
693 res_count <= scsi_in(sc)->length))
694 scsi_in(sc)->resid = res_count;
696 sc->result = (DID_BAD_TARGET << 16) | rhdr->cmd_status;
699 if (rhdr->flags & (ISCSI_FLAG_CMD_UNDERFLOW |
700 ISCSI_FLAG_CMD_OVERFLOW)) {
701 int res_count = be32_to_cpu(rhdr->residual_count);
704 (rhdr->flags & ISCSI_FLAG_CMD_OVERFLOW ||
705 res_count <= scsi_bufflen(sc)))
706 /* write side for bidi or uni-io set_resid */
707 scsi_set_resid(sc, res_count);
709 sc->result = (DID_BAD_TARGET << 16) | rhdr->cmd_status;
712 ISCSI_DBG_SESSION(session, "done [sc %p res %d itt 0x%x]\n",
713 sc, sc->result, task->itt);
714 conn->scsirsp_pdus_cnt++;
716 __iscsi_put_task(task);
720 * iscsi_data_in_rsp - SCSI Data-In Response processing
721 * @conn: iscsi connection
723 * @task: scsi command task
726 iscsi_data_in_rsp(struct iscsi_conn *conn, struct iscsi_hdr *hdr,
727 struct iscsi_task *task)
729 struct iscsi_data_rsp *rhdr = (struct iscsi_data_rsp *)hdr;
730 struct scsi_cmnd *sc = task->sc;
732 if (!(rhdr->flags & ISCSI_FLAG_DATA_STATUS))
735 iscsi_update_cmdsn(conn->session, (struct iscsi_nopin *)hdr);
736 sc->result = (DID_OK << 16) | rhdr->cmd_status;
737 conn->exp_statsn = be32_to_cpu(rhdr->statsn) + 1;
738 if (rhdr->flags & (ISCSI_FLAG_DATA_UNDERFLOW |
739 ISCSI_FLAG_DATA_OVERFLOW)) {
740 int res_count = be32_to_cpu(rhdr->residual_count);
743 (rhdr->flags & ISCSI_FLAG_CMD_OVERFLOW ||
744 res_count <= scsi_in(sc)->length))
745 scsi_in(sc)->resid = res_count;
747 sc->result = (DID_BAD_TARGET << 16) | rhdr->cmd_status;
750 conn->scsirsp_pdus_cnt++;
751 __iscsi_put_task(task);
754 static void iscsi_tmf_rsp(struct iscsi_conn *conn, struct iscsi_hdr *hdr)
756 struct iscsi_tm_rsp *tmf = (struct iscsi_tm_rsp *)hdr;
758 conn->exp_statsn = be32_to_cpu(hdr->statsn) + 1;
759 conn->tmfrsp_pdus_cnt++;
761 if (conn->tmf_state != TMF_QUEUED)
764 if (tmf->response == ISCSI_TMF_RSP_COMPLETE)
765 conn->tmf_state = TMF_SUCCESS;
766 else if (tmf->response == ISCSI_TMF_RSP_NO_TASK)
767 conn->tmf_state = TMF_NOT_FOUND;
769 conn->tmf_state = TMF_FAILED;
770 wake_up(&conn->ehwait);
773 static void iscsi_send_nopout(struct iscsi_conn *conn, struct iscsi_nopin *rhdr)
775 struct iscsi_nopout hdr;
776 struct iscsi_task *task;
778 if (!rhdr && conn->ping_task)
781 memset(&hdr, 0, sizeof(struct iscsi_nopout));
782 hdr.opcode = ISCSI_OP_NOOP_OUT | ISCSI_OP_IMMEDIATE;
783 hdr.flags = ISCSI_FLAG_CMD_FINAL;
786 memcpy(hdr.lun, rhdr->lun, 8);
788 hdr.itt = RESERVED_ITT;
790 hdr.ttt = RESERVED_ITT;
792 task = __iscsi_conn_send_pdu(conn, (struct iscsi_hdr *)&hdr, NULL, 0);
794 iscsi_conn_printk(KERN_ERR, conn, "Could not send nopout\n");
796 /* only track our nops */
797 conn->ping_task = task;
798 conn->last_ping = jiffies;
802 static int iscsi_handle_reject(struct iscsi_conn *conn, struct iscsi_hdr *hdr,
803 char *data, int datalen)
805 struct iscsi_reject *reject = (struct iscsi_reject *)hdr;
806 struct iscsi_hdr rejected_pdu;
808 conn->exp_statsn = be32_to_cpu(reject->statsn) + 1;
810 if (reject->reason == ISCSI_REASON_DATA_DIGEST_ERROR) {
811 if (ntoh24(reject->dlength) > datalen)
812 return ISCSI_ERR_PROTO;
814 if (ntoh24(reject->dlength) >= sizeof(struct iscsi_hdr)) {
815 memcpy(&rejected_pdu, data, sizeof(struct iscsi_hdr));
816 iscsi_conn_printk(KERN_ERR, conn,
817 "pdu (op 0x%x) rejected "
818 "due to DataDigest error.\n",
819 rejected_pdu.opcode);
826 * iscsi_itt_to_task - look up task by itt
827 * @conn: iscsi connection
830 * This should be used for mgmt tasks like login and nops, or if
831 * the LDD's itt space does not include the session age.
833 * The session lock must be held.
835 struct iscsi_task *iscsi_itt_to_task(struct iscsi_conn *conn, itt_t itt)
837 struct iscsi_session *session = conn->session;
840 if (itt == RESERVED_ITT)
843 if (session->tt->parse_pdu_itt)
844 session->tt->parse_pdu_itt(conn, itt, &i, NULL);
847 if (i >= session->cmds_max)
850 return session->cmds[i];
852 EXPORT_SYMBOL_GPL(iscsi_itt_to_task);
855 * __iscsi_complete_pdu - complete pdu
859 * @datalen: len of data buffer
861 * Completes pdu processing by freeing any resources allocated at
862 * queuecommand or send generic. session lock must be held and verify
863 * itt must have been called.
865 int __iscsi_complete_pdu(struct iscsi_conn *conn, struct iscsi_hdr *hdr,
866 char *data, int datalen)
868 struct iscsi_session *session = conn->session;
869 int opcode = hdr->opcode & ISCSI_OPCODE_MASK, rc = 0;
870 struct iscsi_task *task;
873 conn->last_recv = jiffies;
874 rc = iscsi_verify_itt(conn, hdr->itt);
878 if (hdr->itt != RESERVED_ITT)
879 itt = get_itt(hdr->itt);
883 ISCSI_DBG_SESSION(session, "[op 0x%x cid %d itt 0x%x len %d]\n",
884 opcode, conn->id, itt, datalen);
887 iscsi_update_cmdsn(session, (struct iscsi_nopin*)hdr);
890 case ISCSI_OP_NOOP_IN:
892 rc = ISCSI_ERR_PROTO;
896 if (hdr->ttt == cpu_to_be32(ISCSI_RESERVED_TAG))
899 iscsi_send_nopout(conn, (struct iscsi_nopin*)hdr);
901 case ISCSI_OP_REJECT:
902 rc = iscsi_handle_reject(conn, hdr, data, datalen);
904 case ISCSI_OP_ASYNC_EVENT:
905 conn->exp_statsn = be32_to_cpu(hdr->statsn) + 1;
906 if (iscsi_recv_pdu(conn->cls_conn, hdr, data, datalen))
907 rc = ISCSI_ERR_CONN_FAILED;
910 rc = ISCSI_ERR_BAD_OPCODE;
917 case ISCSI_OP_SCSI_CMD_RSP:
918 case ISCSI_OP_SCSI_DATA_IN:
919 task = iscsi_itt_to_ctask(conn, hdr->itt);
921 return ISCSI_ERR_BAD_ITT;
925 * LLD handles R2Ts if they need to.
928 case ISCSI_OP_LOGOUT_RSP:
929 case ISCSI_OP_LOGIN_RSP:
930 case ISCSI_OP_TEXT_RSP:
931 case ISCSI_OP_SCSI_TMFUNC_RSP:
932 case ISCSI_OP_NOOP_IN:
933 task = iscsi_itt_to_task(conn, hdr->itt);
935 return ISCSI_ERR_BAD_ITT;
938 return ISCSI_ERR_BAD_OPCODE;
942 case ISCSI_OP_SCSI_CMD_RSP:
943 iscsi_scsi_cmd_rsp(conn, hdr, task, data, datalen);
945 case ISCSI_OP_SCSI_DATA_IN:
946 iscsi_data_in_rsp(conn, hdr, task);
948 case ISCSI_OP_LOGOUT_RSP:
949 iscsi_update_cmdsn(session, (struct iscsi_nopin*)hdr);
951 rc = ISCSI_ERR_PROTO;
954 conn->exp_statsn = be32_to_cpu(hdr->statsn) + 1;
956 case ISCSI_OP_LOGIN_RSP:
957 case ISCSI_OP_TEXT_RSP:
958 iscsi_update_cmdsn(session, (struct iscsi_nopin*)hdr);
960 * login related PDU's exp_statsn is handled in
964 case ISCSI_OP_SCSI_TMFUNC_RSP:
965 iscsi_update_cmdsn(session, (struct iscsi_nopin*)hdr);
967 rc = ISCSI_ERR_PROTO;
971 iscsi_tmf_rsp(conn, hdr);
972 __iscsi_put_task(task);
974 case ISCSI_OP_NOOP_IN:
975 iscsi_update_cmdsn(session, (struct iscsi_nopin*)hdr);
976 if (hdr->ttt != cpu_to_be32(ISCSI_RESERVED_TAG) || datalen) {
977 rc = ISCSI_ERR_PROTO;
980 conn->exp_statsn = be32_to_cpu(hdr->statsn) + 1;
982 if (conn->ping_task != task)
984 * If this is not in response to one of our
985 * nops then it must be from userspace.
989 mod_timer(&conn->transport_timer, jiffies + conn->recv_timeout);
990 __iscsi_put_task(task);
993 rc = ISCSI_ERR_BAD_OPCODE;
1000 if (iscsi_recv_pdu(conn->cls_conn, hdr, data, datalen))
1001 rc = ISCSI_ERR_CONN_FAILED;
1002 __iscsi_put_task(task);
1005 EXPORT_SYMBOL_GPL(__iscsi_complete_pdu);
1007 int iscsi_complete_pdu(struct iscsi_conn *conn, struct iscsi_hdr *hdr,
1008 char *data, int datalen)
1012 spin_lock(&conn->session->lock);
1013 rc = __iscsi_complete_pdu(conn, hdr, data, datalen);
1014 spin_unlock(&conn->session->lock);
1017 EXPORT_SYMBOL_GPL(iscsi_complete_pdu);
1019 int iscsi_verify_itt(struct iscsi_conn *conn, itt_t itt)
1021 struct iscsi_session *session = conn->session;
1024 if (itt == RESERVED_ITT)
1027 if (session->tt->parse_pdu_itt)
1028 session->tt->parse_pdu_itt(conn, itt, &i, &age);
1031 age = ((__force u32)itt >> ISCSI_AGE_SHIFT) & ISCSI_AGE_MASK;
1034 if (age != session->age) {
1035 iscsi_conn_printk(KERN_ERR, conn,
1036 "received itt %x expected session age (%x)\n",
1037 (__force u32)itt, session->age);
1038 return ISCSI_ERR_BAD_ITT;
1041 if (i >= session->cmds_max) {
1042 iscsi_conn_printk(KERN_ERR, conn,
1043 "received invalid itt index %u (max cmds "
1044 "%u.\n", i, session->cmds_max);
1045 return ISCSI_ERR_BAD_ITT;
1049 EXPORT_SYMBOL_GPL(iscsi_verify_itt);
1052 * iscsi_itt_to_ctask - look up ctask by itt
1053 * @conn: iscsi connection
1056 * This should be used for cmd tasks.
1058 * The session lock must be held.
1060 struct iscsi_task *iscsi_itt_to_ctask(struct iscsi_conn *conn, itt_t itt)
1062 struct iscsi_task *task;
1064 if (iscsi_verify_itt(conn, itt))
1067 task = iscsi_itt_to_task(conn, itt);
1068 if (!task || !task->sc)
1071 if (task->sc->SCp.phase != conn->session->age) {
1072 iscsi_session_printk(KERN_ERR, conn->session,
1073 "task's session age %d, expected %d\n",
1074 task->sc->SCp.phase, conn->session->age);
1080 EXPORT_SYMBOL_GPL(iscsi_itt_to_ctask);
1082 void iscsi_session_failure(struct iscsi_session *session,
1085 struct iscsi_conn *conn;
1087 unsigned long flags;
1089 spin_lock_irqsave(&session->lock, flags);
1090 conn = session->leadconn;
1091 if (session->state == ISCSI_STATE_TERMINATE || !conn) {
1092 spin_unlock_irqrestore(&session->lock, flags);
1096 dev = get_device(&conn->cls_conn->dev);
1097 spin_unlock_irqrestore(&session->lock, flags);
1101 * if the host is being removed bypass the connection
1102 * recovery initialization because we are going to kill
1105 if (err == ISCSI_ERR_INVALID_HOST)
1106 iscsi_conn_error_event(conn->cls_conn, err);
1108 iscsi_conn_failure(conn, err);
1111 EXPORT_SYMBOL_GPL(iscsi_session_failure);
1113 void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err)
1115 struct iscsi_session *session = conn->session;
1116 unsigned long flags;
1118 spin_lock_irqsave(&session->lock, flags);
1119 if (session->state == ISCSI_STATE_FAILED) {
1120 spin_unlock_irqrestore(&session->lock, flags);
1124 if (conn->stop_stage == 0)
1125 session->state = ISCSI_STATE_FAILED;
1126 spin_unlock_irqrestore(&session->lock, flags);
1128 set_bit(ISCSI_SUSPEND_BIT, &conn->suspend_tx);
1129 set_bit(ISCSI_SUSPEND_BIT, &conn->suspend_rx);
1130 iscsi_conn_error_event(conn->cls_conn, err);
1132 EXPORT_SYMBOL_GPL(iscsi_conn_failure);
1134 static int iscsi_check_cmdsn_window_closed(struct iscsi_conn *conn)
1136 struct iscsi_session *session = conn->session;
1139 * Check for iSCSI window and take care of CmdSN wrap-around
1141 if (!iscsi_sna_lte(session->queued_cmdsn, session->max_cmdsn)) {
1142 ISCSI_DBG_SESSION(session, "iSCSI CmdSN closed. ExpCmdSn "
1143 "%u MaxCmdSN %u CmdSN %u/%u\n",
1144 session->exp_cmdsn, session->max_cmdsn,
1145 session->cmdsn, session->queued_cmdsn);
1151 static int iscsi_xmit_task(struct iscsi_conn *conn)
1153 struct iscsi_task *task = conn->task;
1156 __iscsi_get_task(task);
1157 spin_unlock_bh(&conn->session->lock);
1158 rc = conn->session->tt->xmit_task(task);
1159 spin_lock_bh(&conn->session->lock);
1160 __iscsi_put_task(task);
1162 /* done with this task */
1168 * iscsi_requeue_task - requeue task to run from session workqueue
1169 * @task: task to requeue
1171 * LLDs that need to run a task from the session workqueue should call
1172 * this. The session lock must be held. This should only be called
1173 * by software drivers.
1175 void iscsi_requeue_task(struct iscsi_task *task)
1177 struct iscsi_conn *conn = task->conn;
1179 list_move_tail(&task->running, &conn->requeue);
1180 iscsi_conn_queue_work(conn);
1182 EXPORT_SYMBOL_GPL(iscsi_requeue_task);
1185 * iscsi_data_xmit - xmit any command into the scheduled connection
1186 * @conn: iscsi connection
1189 * The function can return -EAGAIN in which case the caller must
1190 * re-schedule it again later or recover. '0' return code means
1193 static int iscsi_data_xmit(struct iscsi_conn *conn)
1197 spin_lock_bh(&conn->session->lock);
1198 if (unlikely(conn->suspend_tx)) {
1199 ISCSI_DBG_SESSION(conn->session, "Tx suspended!\n");
1200 spin_unlock_bh(&conn->session->lock);
1205 rc = iscsi_xmit_task(conn);
1211 * process mgmt pdus like nops before commands since we should
1212 * only have one nop-out as a ping from us and targets should not
1213 * overflow us with nop-ins
1216 while (!list_empty(&conn->mgmtqueue)) {
1217 conn->task = list_entry(conn->mgmtqueue.next,
1218 struct iscsi_task, running);
1219 if (iscsi_prep_mgmt_task(conn, conn->task)) {
1220 __iscsi_put_task(conn->task);
1224 rc = iscsi_xmit_task(conn);
1229 /* process pending command queue */
1230 while (!list_empty(&conn->xmitqueue)) {
1231 if (conn->tmf_state == TMF_QUEUED)
1234 conn->task = list_entry(conn->xmitqueue.next,
1235 struct iscsi_task, running);
1236 if (conn->session->state == ISCSI_STATE_LOGGING_OUT) {
1237 fail_command(conn, conn->task, DID_IMM_RETRY << 16);
1240 rc = iscsi_prep_scsi_cmd_pdu(conn->task);
1242 if (rc == -ENOMEM) {
1246 fail_command(conn, conn->task, DID_ABORT << 16);
1249 rc = iscsi_xmit_task(conn);
1253 * we could continuously get new task requests so
1254 * we need to check the mgmt queue for nops that need to
1255 * be sent to aviod starvation
1257 if (!list_empty(&conn->mgmtqueue))
1261 while (!list_empty(&conn->requeue)) {
1262 if (conn->session->fast_abort && conn->tmf_state != TMF_INITIAL)
1266 * we always do fastlogout - conn stop code will clean up.
1268 if (conn->session->state == ISCSI_STATE_LOGGING_OUT)
1271 conn->task = list_entry(conn->requeue.next,
1272 struct iscsi_task, running);
1273 conn->task->state = ISCSI_TASK_RUNNING;
1274 list_move_tail(conn->requeue.next, &conn->run_list);
1275 rc = iscsi_xmit_task(conn);
1278 if (!list_empty(&conn->mgmtqueue))
1281 spin_unlock_bh(&conn->session->lock);
1285 if (unlikely(conn->suspend_tx))
1287 spin_unlock_bh(&conn->session->lock);
1291 static void iscsi_xmitworker(struct work_struct *work)
1293 struct iscsi_conn *conn =
1294 container_of(work, struct iscsi_conn, xmitwork);
1297 * serialize Xmit worker on a per-connection basis.
1300 rc = iscsi_data_xmit(conn);
1301 } while (rc >= 0 || rc == -EAGAIN);
1304 static inline struct iscsi_task *iscsi_alloc_task(struct iscsi_conn *conn,
1305 struct scsi_cmnd *sc)
1307 struct iscsi_task *task;
1309 if (!__kfifo_get(conn->session->cmdpool.queue,
1310 (void *) &task, sizeof(void *)))
1313 sc->SCp.phase = conn->session->age;
1314 sc->SCp.ptr = (char *) task;
1316 atomic_set(&task->refcount, 1);
1317 task->state = ISCSI_TASK_PENDING;
1320 INIT_LIST_HEAD(&task->running);
1325 FAILURE_BAD_HOST = 1,
1326 FAILURE_SESSION_FAILED,
1327 FAILURE_SESSION_FREED,
1328 FAILURE_WINDOW_CLOSED,
1330 FAILURE_SESSION_TERMINATE,
1331 FAILURE_SESSION_IN_RECOVERY,
1332 FAILURE_SESSION_RECOVERY_TIMEOUT,
1333 FAILURE_SESSION_LOGGING_OUT,
1334 FAILURE_SESSION_NOT_READY,
1337 int iscsi_queuecommand(struct scsi_cmnd *sc, void (*done)(struct scsi_cmnd *))
1339 struct iscsi_cls_session *cls_session;
1340 struct Scsi_Host *host;
1342 struct iscsi_session *session;
1343 struct iscsi_conn *conn;
1344 struct iscsi_task *task = NULL;
1346 sc->scsi_done = done;
1350 host = sc->device->host;
1351 spin_unlock(host->host_lock);
1353 cls_session = starget_to_session(scsi_target(sc->device));
1354 session = cls_session->dd_data;
1355 spin_lock(&session->lock);
1357 reason = iscsi_session_chkready(cls_session);
1359 sc->result = reason;
1364 * ISCSI_STATE_FAILED is a temp. state. The recovery
1365 * code will decide what is best to do with command queued
1368 if (session->state != ISCSI_STATE_LOGGED_IN &&
1369 session->state != ISCSI_STATE_FAILED) {
1371 * to handle the race between when we set the recovery state
1372 * and block the session we requeue here (commands could
1373 * be entering our queuecommand while a block is starting
1374 * up because the block code is not locked)
1376 switch (session->state) {
1377 case ISCSI_STATE_IN_RECOVERY:
1378 reason = FAILURE_SESSION_IN_RECOVERY;
1380 case ISCSI_STATE_LOGGING_OUT:
1381 reason = FAILURE_SESSION_LOGGING_OUT;
1383 case ISCSI_STATE_RECOVERY_FAILED:
1384 reason = FAILURE_SESSION_RECOVERY_TIMEOUT;
1385 sc->result = DID_TRANSPORT_FAILFAST << 16;
1387 case ISCSI_STATE_TERMINATE:
1388 reason = FAILURE_SESSION_TERMINATE;
1389 sc->result = DID_NO_CONNECT << 16;
1392 reason = FAILURE_SESSION_FREED;
1393 sc->result = DID_NO_CONNECT << 16;
1398 conn = session->leadconn;
1400 reason = FAILURE_SESSION_FREED;
1401 sc->result = DID_NO_CONNECT << 16;
1405 if (iscsi_check_cmdsn_window_closed(conn)) {
1406 reason = FAILURE_WINDOW_CLOSED;
1410 task = iscsi_alloc_task(conn, sc);
1412 reason = FAILURE_OOM;
1415 list_add_tail(&task->running, &conn->xmitqueue);
1417 if (session->tt->caps & CAP_DATA_PATH_OFFLOAD) {
1418 reason = iscsi_prep_scsi_cmd_pdu(task);
1420 if (reason == -ENOMEM) {
1421 reason = FAILURE_OOM;
1424 sc->result = DID_ABORT << 16;
1428 if (session->tt->xmit_task(task)) {
1429 reason = FAILURE_SESSION_NOT_READY;
1433 iscsi_conn_queue_work(conn);
1435 session->queued_cmdsn++;
1436 spin_unlock(&session->lock);
1437 spin_lock(host->host_lock);
1441 sc->scsi_done = NULL;
1442 iscsi_complete_command(task);
1444 spin_unlock(&session->lock);
1445 ISCSI_DBG_SESSION(session, "cmd 0x%x rejected (%d)\n",
1446 sc->cmnd[0], reason);
1447 spin_lock(host->host_lock);
1448 return SCSI_MLQUEUE_TARGET_BUSY;
1451 sc->scsi_done = NULL;
1452 iscsi_complete_command(task);
1454 spin_unlock(&session->lock);
1455 ISCSI_DBG_SESSION(session, "iscsi: cmd 0x%x is not queued (%d)\n",
1456 sc->cmnd[0], reason);
1457 if (!scsi_bidi_cmnd(sc))
1458 scsi_set_resid(sc, scsi_bufflen(sc));
1460 scsi_out(sc)->resid = scsi_out(sc)->length;
1461 scsi_in(sc)->resid = scsi_in(sc)->length;
1464 spin_lock(host->host_lock);
1467 EXPORT_SYMBOL_GPL(iscsi_queuecommand);
1469 int iscsi_change_queue_depth(struct scsi_device *sdev, int depth)
1471 scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), depth);
1472 return sdev->queue_depth;
1474 EXPORT_SYMBOL_GPL(iscsi_change_queue_depth);
1476 int iscsi_target_alloc(struct scsi_target *starget)
1478 struct iscsi_cls_session *cls_session = starget_to_session(starget);
1479 struct iscsi_session *session = cls_session->dd_data;
1481 starget->can_queue = session->scsi_cmds_max;
1484 EXPORT_SYMBOL_GPL(iscsi_target_alloc);
1486 void iscsi_session_recovery_timedout(struct iscsi_cls_session *cls_session)
1488 struct iscsi_session *session = cls_session->dd_data;
1490 spin_lock_bh(&session->lock);
1491 if (session->state != ISCSI_STATE_LOGGED_IN) {
1492 session->state = ISCSI_STATE_RECOVERY_FAILED;
1493 if (session->leadconn)
1494 wake_up(&session->leadconn->ehwait);
1496 spin_unlock_bh(&session->lock);
1498 EXPORT_SYMBOL_GPL(iscsi_session_recovery_timedout);
1500 int iscsi_eh_target_reset(struct scsi_cmnd *sc)
1502 struct iscsi_cls_session *cls_session;
1503 struct iscsi_session *session;
1504 struct iscsi_conn *conn;
1506 cls_session = starget_to_session(scsi_target(sc->device));
1507 session = cls_session->dd_data;
1508 conn = session->leadconn;
1510 mutex_lock(&session->eh_mutex);
1511 spin_lock_bh(&session->lock);
1512 if (session->state == ISCSI_STATE_TERMINATE) {
1514 iscsi_session_printk(KERN_INFO, session,
1515 "failing target reset: Could not log "
1516 "back into target [age %d]\n",
1518 spin_unlock_bh(&session->lock);
1519 mutex_unlock(&session->eh_mutex);
1523 spin_unlock_bh(&session->lock);
1524 mutex_unlock(&session->eh_mutex);
1526 * we drop the lock here but the leadconn cannot be destoyed while
1527 * we are in the scsi eh
1529 iscsi_conn_failure(conn, ISCSI_ERR_CONN_FAILED);
1531 ISCSI_DBG_SESSION(session, "wait for relogin\n");
1532 wait_event_interruptible(conn->ehwait,
1533 session->state == ISCSI_STATE_TERMINATE ||
1534 session->state == ISCSI_STATE_LOGGED_IN ||
1535 session->state == ISCSI_STATE_RECOVERY_FAILED);
1536 if (signal_pending(current))
1537 flush_signals(current);
1539 mutex_lock(&session->eh_mutex);
1540 spin_lock_bh(&session->lock);
1541 if (session->state == ISCSI_STATE_LOGGED_IN)
1542 iscsi_session_printk(KERN_INFO, session,
1543 "target reset succeeded\n");
1546 spin_unlock_bh(&session->lock);
1547 mutex_unlock(&session->eh_mutex);
1550 EXPORT_SYMBOL_GPL(iscsi_eh_target_reset);
1552 static void iscsi_tmf_timedout(unsigned long data)
1554 struct iscsi_conn *conn = (struct iscsi_conn *)data;
1555 struct iscsi_session *session = conn->session;
1557 spin_lock(&session->lock);
1558 if (conn->tmf_state == TMF_QUEUED) {
1559 conn->tmf_state = TMF_TIMEDOUT;
1560 ISCSI_DBG_SESSION(session, "tmf timedout\n");
1561 /* unblock eh_abort() */
1562 wake_up(&conn->ehwait);
1564 spin_unlock(&session->lock);
1567 static int iscsi_exec_task_mgmt_fn(struct iscsi_conn *conn,
1568 struct iscsi_tm *hdr, int age,
1571 struct iscsi_session *session = conn->session;
1572 struct iscsi_task *task;
1574 task = __iscsi_conn_send_pdu(conn, (struct iscsi_hdr *)hdr,
1577 spin_unlock_bh(&session->lock);
1578 iscsi_conn_failure(conn, ISCSI_ERR_CONN_FAILED);
1579 spin_lock_bh(&session->lock);
1580 ISCSI_DBG_SESSION(session, "tmf exec failure\n");
1583 conn->tmfcmd_pdus_cnt++;
1584 conn->tmf_timer.expires = timeout * HZ + jiffies;
1585 conn->tmf_timer.function = iscsi_tmf_timedout;
1586 conn->tmf_timer.data = (unsigned long)conn;
1587 add_timer(&conn->tmf_timer);
1588 ISCSI_DBG_SESSION(session, "tmf set timeout\n");
1590 spin_unlock_bh(&session->lock);
1591 mutex_unlock(&session->eh_mutex);
1594 * block eh thread until:
1598 * 3) session is terminated or restarted or userspace has
1599 * given up on recovery
1601 wait_event_interruptible(conn->ehwait, age != session->age ||
1602 session->state != ISCSI_STATE_LOGGED_IN ||
1603 conn->tmf_state != TMF_QUEUED);
1604 if (signal_pending(current))
1605 flush_signals(current);
1606 del_timer_sync(&conn->tmf_timer);
1608 mutex_lock(&session->eh_mutex);
1609 spin_lock_bh(&session->lock);
1610 /* if the session drops it will clean up the task */
1611 if (age != session->age ||
1612 session->state != ISCSI_STATE_LOGGED_IN)
1618 * Fail commands. session lock held and recv side suspended and xmit
1621 static void fail_all_commands(struct iscsi_conn *conn, unsigned lun,
1624 struct iscsi_task *task, *tmp;
1628 (conn->task->sc && conn->task->sc->device->lun == lun))
1633 list_for_each_entry_safe(task, tmp, &conn->xmitqueue, running) {
1634 if (lun == task->sc->device->lun || lun == -1) {
1635 ISCSI_DBG_SESSION(conn->session,
1636 "failing pending sc %p itt 0x%x\n",
1637 task->sc, task->itt);
1638 fail_command(conn, task, error << 16);
1642 list_for_each_entry_safe(task, tmp, &conn->requeue, running) {
1643 if (lun == task->sc->device->lun || lun == -1) {
1644 ISCSI_DBG_SESSION(conn->session,
1645 "failing requeued sc %p itt 0x%x\n",
1646 task->sc, task->itt);
1647 fail_command(conn, task, error << 16);
1651 /* fail all other running */
1652 list_for_each_entry_safe(task, tmp, &conn->run_list, running) {
1653 if (lun == task->sc->device->lun || lun == -1) {
1654 ISCSI_DBG_SESSION(conn->session,
1655 "failing in progress sc %p itt 0x%x\n",
1656 task->sc, task->itt);
1657 fail_command(conn, task, error << 16);
1662 void iscsi_suspend_tx(struct iscsi_conn *conn)
1664 struct Scsi_Host *shost = conn->session->host;
1665 struct iscsi_host *ihost = shost_priv(shost);
1667 set_bit(ISCSI_SUSPEND_BIT, &conn->suspend_tx);
1668 if (!(conn->session->tt->caps & CAP_DATA_PATH_OFFLOAD))
1669 flush_workqueue(ihost->workq);
1671 EXPORT_SYMBOL_GPL(iscsi_suspend_tx);
1673 static void iscsi_start_tx(struct iscsi_conn *conn)
1675 clear_bit(ISCSI_SUSPEND_BIT, &conn->suspend_tx);
1676 if (!(conn->session->tt->caps & CAP_DATA_PATH_OFFLOAD))
1677 iscsi_conn_queue_work(conn);
1681 * We want to make sure a ping is in flight. It has timed out.
1682 * And we are not busy processing a pdu that is making
1683 * progress but got started before the ping and is taking a while
1684 * to complete so the ping is just stuck behind it in a queue.
1686 static int iscsi_has_ping_timed_out(struct iscsi_conn *conn)
1688 if (conn->ping_task &&
1689 time_before_eq(conn->last_recv + (conn->recv_timeout * HZ) +
1690 (conn->ping_timeout * HZ), jiffies))
1696 static enum blk_eh_timer_return iscsi_eh_cmd_timed_out(struct scsi_cmnd *scmd)
1698 struct iscsi_cls_session *cls_session;
1699 struct iscsi_session *session;
1700 struct iscsi_conn *conn;
1701 enum blk_eh_timer_return rc = BLK_EH_NOT_HANDLED;
1703 cls_session = starget_to_session(scsi_target(scmd->device));
1704 session = cls_session->dd_data;
1706 ISCSI_DBG_SESSION(session, "scsi cmd %p timedout\n", scmd);
1708 spin_lock(&session->lock);
1709 if (session->state != ISCSI_STATE_LOGGED_IN) {
1711 * We are probably in the middle of iscsi recovery so let
1712 * that complete and handle the error.
1714 rc = BLK_EH_RESET_TIMER;
1718 conn = session->leadconn;
1720 /* In the middle of shuting down */
1721 rc = BLK_EH_RESET_TIMER;
1725 if (!conn->recv_timeout && !conn->ping_timeout)
1728 * if the ping timedout then we are in the middle of cleaning up
1729 * and can let the iscsi eh handle it
1731 if (iscsi_has_ping_timed_out(conn)) {
1732 rc = BLK_EH_RESET_TIMER;
1736 * if we are about to check the transport then give the command
1739 if (time_before_eq(conn->last_recv + (conn->recv_timeout * HZ),
1741 rc = BLK_EH_RESET_TIMER;
1745 /* if in the middle of checking the transport then give us more time */
1746 if (conn->ping_task)
1747 rc = BLK_EH_RESET_TIMER;
1749 spin_unlock(&session->lock);
1750 ISCSI_DBG_SESSION(session, "return %s\n", rc == BLK_EH_RESET_TIMER ?
1751 "timer reset" : "nh");
1755 static void iscsi_check_transport_timeouts(unsigned long data)
1757 struct iscsi_conn *conn = (struct iscsi_conn *)data;
1758 struct iscsi_session *session = conn->session;
1759 unsigned long recv_timeout, next_timeout = 0, last_recv;
1761 spin_lock(&session->lock);
1762 if (session->state != ISCSI_STATE_LOGGED_IN)
1765 recv_timeout = conn->recv_timeout;
1770 last_recv = conn->last_recv;
1772 if (iscsi_has_ping_timed_out(conn)) {
1773 iscsi_conn_printk(KERN_ERR, conn, "ping timeout of %d secs "
1774 "expired, recv timeout %d, last rx %lu, "
1775 "last ping %lu, now %lu\n",
1776 conn->ping_timeout, conn->recv_timeout,
1777 last_recv, conn->last_ping, jiffies);
1778 spin_unlock(&session->lock);
1779 iscsi_conn_failure(conn, ISCSI_ERR_CONN_FAILED);
1783 if (time_before_eq(last_recv + recv_timeout, jiffies)) {
1784 /* send a ping to try to provoke some traffic */
1785 ISCSI_DBG_CONN(conn, "Sending nopout as ping\n");
1786 iscsi_send_nopout(conn, NULL);
1787 next_timeout = conn->last_ping + (conn->ping_timeout * HZ);
1789 next_timeout = last_recv + recv_timeout;
1791 ISCSI_DBG_CONN(conn, "Setting next tmo %lu\n", next_timeout);
1792 mod_timer(&conn->transport_timer, next_timeout);
1794 spin_unlock(&session->lock);
1797 static void iscsi_prep_abort_task_pdu(struct iscsi_task *task,
1798 struct iscsi_tm *hdr)
1800 memset(hdr, 0, sizeof(*hdr));
1801 hdr->opcode = ISCSI_OP_SCSI_TMFUNC | ISCSI_OP_IMMEDIATE;
1802 hdr->flags = ISCSI_TM_FUNC_ABORT_TASK & ISCSI_FLAG_TM_FUNC_MASK;
1803 hdr->flags |= ISCSI_FLAG_CMD_FINAL;
1804 memcpy(hdr->lun, task->lun, sizeof(hdr->lun));
1805 hdr->rtt = task->hdr_itt;
1806 hdr->refcmdsn = task->cmdsn;
1809 int iscsi_eh_abort(struct scsi_cmnd *sc)
1811 struct iscsi_cls_session *cls_session;
1812 struct iscsi_session *session;
1813 struct iscsi_conn *conn;
1814 struct iscsi_task *task;
1815 struct iscsi_tm *hdr;
1818 cls_session = starget_to_session(scsi_target(sc->device));
1819 session = cls_session->dd_data;
1821 mutex_lock(&session->eh_mutex);
1822 spin_lock_bh(&session->lock);
1824 * if session was ISCSI_STATE_IN_RECOVERY then we may not have
1828 ISCSI_DBG_SESSION(session, "sc never reached iscsi layer or "
1830 spin_unlock_bh(&session->lock);
1831 mutex_unlock(&session->eh_mutex);
1836 * If we are not logged in or we have started a new session
1837 * then let the host reset code handle this
1839 if (!session->leadconn || session->state != ISCSI_STATE_LOGGED_IN ||
1840 sc->SCp.phase != session->age) {
1841 spin_unlock_bh(&session->lock);
1842 mutex_unlock(&session->eh_mutex);
1846 conn = session->leadconn;
1847 conn->eh_abort_cnt++;
1850 task = (struct iscsi_task *)sc->SCp.ptr;
1851 ISCSI_DBG_SESSION(session, "aborting [sc %p itt 0x%x]\n",
1854 /* task completed before time out */
1856 ISCSI_DBG_SESSION(session, "sc completed while abort in "
1861 if (task->state == ISCSI_TASK_PENDING) {
1862 fail_command(conn, task, DID_ABORT << 16);
1866 /* only have one tmf outstanding at a time */
1867 if (conn->tmf_state != TMF_INITIAL)
1869 conn->tmf_state = TMF_QUEUED;
1872 iscsi_prep_abort_task_pdu(task, hdr);
1874 if (iscsi_exec_task_mgmt_fn(conn, hdr, age, session->abort_timeout)) {
1879 switch (conn->tmf_state) {
1881 spin_unlock_bh(&session->lock);
1883 * stop tx side incase the target had sent a abort rsp but
1884 * the initiator was still writing out data.
1886 iscsi_suspend_tx(conn);
1888 * we do not stop the recv side because targets have been
1889 * good and have never sent us a successful tmf response
1890 * then sent more data for the cmd.
1892 spin_lock(&session->lock);
1893 fail_command(conn, task, DID_ABORT << 16);
1894 conn->tmf_state = TMF_INITIAL;
1895 spin_unlock(&session->lock);
1896 iscsi_start_tx(conn);
1897 goto success_unlocked;
1899 spin_unlock_bh(&session->lock);
1900 iscsi_conn_failure(conn, ISCSI_ERR_CONN_FAILED);
1901 goto failed_unlocked;
1904 conn->tmf_state = TMF_INITIAL;
1905 /* task completed before tmf abort response */
1906 ISCSI_DBG_SESSION(session, "sc completed while abort "
1912 conn->tmf_state = TMF_INITIAL;
1917 spin_unlock_bh(&session->lock);
1919 ISCSI_DBG_SESSION(session, "abort success [sc %p itt 0x%x]\n",
1921 mutex_unlock(&session->eh_mutex);
1925 spin_unlock_bh(&session->lock);
1927 ISCSI_DBG_SESSION(session, "abort failed [sc %p itt 0x%x]\n", sc,
1928 task ? task->itt : 0);
1929 mutex_unlock(&session->eh_mutex);
1932 EXPORT_SYMBOL_GPL(iscsi_eh_abort);
1934 static void iscsi_prep_lun_reset_pdu(struct scsi_cmnd *sc, struct iscsi_tm *hdr)
1936 memset(hdr, 0, sizeof(*hdr));
1937 hdr->opcode = ISCSI_OP_SCSI_TMFUNC | ISCSI_OP_IMMEDIATE;
1938 hdr->flags = ISCSI_TM_FUNC_LOGICAL_UNIT_RESET & ISCSI_FLAG_TM_FUNC_MASK;
1939 hdr->flags |= ISCSI_FLAG_CMD_FINAL;
1940 int_to_scsilun(sc->device->lun, (struct scsi_lun *)hdr->lun);
1941 hdr->rtt = RESERVED_ITT;
1944 int iscsi_eh_device_reset(struct scsi_cmnd *sc)
1946 struct iscsi_cls_session *cls_session;
1947 struct iscsi_session *session;
1948 struct iscsi_conn *conn;
1949 struct iscsi_tm *hdr;
1952 cls_session = starget_to_session(scsi_target(sc->device));
1953 session = cls_session->dd_data;
1955 ISCSI_DBG_SESSION(session, "LU Reset [sc %p lun %u]\n",
1956 sc, sc->device->lun);
1958 mutex_lock(&session->eh_mutex);
1959 spin_lock_bh(&session->lock);
1961 * Just check if we are not logged in. We cannot check for
1962 * the phase because the reset could come from a ioctl.
1964 if (!session->leadconn || session->state != ISCSI_STATE_LOGGED_IN)
1966 conn = session->leadconn;
1968 /* only have one tmf outstanding at a time */
1969 if (conn->tmf_state != TMF_INITIAL)
1971 conn->tmf_state = TMF_QUEUED;
1974 iscsi_prep_lun_reset_pdu(sc, hdr);
1976 if (iscsi_exec_task_mgmt_fn(conn, hdr, session->age,
1977 session->lu_reset_timeout)) {
1982 switch (conn->tmf_state) {
1986 spin_unlock_bh(&session->lock);
1987 iscsi_conn_failure(conn, ISCSI_ERR_CONN_FAILED);
1990 conn->tmf_state = TMF_INITIAL;
1995 spin_unlock_bh(&session->lock);
1997 iscsi_suspend_tx(conn);
1999 spin_lock_bh(&session->lock);
2000 fail_all_commands(conn, sc->device->lun, DID_ERROR);
2001 conn->tmf_state = TMF_INITIAL;
2002 spin_unlock_bh(&session->lock);
2004 iscsi_start_tx(conn);
2008 spin_unlock_bh(&session->lock);
2010 ISCSI_DBG_SESSION(session, "dev reset result = %s\n",
2011 rc == SUCCESS ? "SUCCESS" : "FAILED");
2012 mutex_unlock(&session->eh_mutex);
2015 EXPORT_SYMBOL_GPL(iscsi_eh_device_reset);
2018 * Pre-allocate a pool of @max items of @item_size. By default, the pool
2019 * should be accessed via kfifo_{get,put} on q->queue.
2020 * Optionally, the caller can obtain the array of object pointers
2021 * by passing in a non-NULL @items pointer
2024 iscsi_pool_init(struct iscsi_pool *q, int max, void ***items, int item_size)
2026 int i, num_arrays = 1;
2028 memset(q, 0, sizeof(*q));
2032 /* If the user passed an items pointer, he wants a copy of
2036 q->pool = kzalloc(num_arrays * max * sizeof(void*), GFP_KERNEL);
2037 if (q->pool == NULL)
2040 q->queue = kfifo_init((void*)q->pool, max * sizeof(void*),
2042 if (IS_ERR(q->queue)) {
2047 for (i = 0; i < max; i++) {
2048 q->pool[i] = kzalloc(item_size, GFP_KERNEL);
2049 if (q->pool[i] == NULL) {
2053 __kfifo_put(q->queue, (void*)&q->pool[i], sizeof(void*));
2057 *items = q->pool + max;
2058 memcpy(*items, q->pool, max * sizeof(void *));
2067 EXPORT_SYMBOL_GPL(iscsi_pool_init);
2069 void iscsi_pool_free(struct iscsi_pool *q)
2073 for (i = 0; i < q->max; i++)
2078 EXPORT_SYMBOL_GPL(iscsi_pool_free);
2081 * iscsi_host_add - add host to system
2083 * @pdev: parent device
2085 * This should be called by partial offload and software iscsi drivers
2086 * to add a host to the system.
2088 int iscsi_host_add(struct Scsi_Host *shost, struct device *pdev)
2090 if (!shost->can_queue)
2091 shost->can_queue = ISCSI_DEF_XMIT_CMDS_MAX;
2093 if (!shost->cmd_per_lun)
2094 shost->cmd_per_lun = ISCSI_DEF_CMD_PER_LUN;
2096 if (!shost->transportt->eh_timed_out)
2097 shost->transportt->eh_timed_out = iscsi_eh_cmd_timed_out;
2098 return scsi_add_host(shost, pdev);
2100 EXPORT_SYMBOL_GPL(iscsi_host_add);
2103 * iscsi_host_alloc - allocate a host and driver data
2104 * @sht: scsi host template
2105 * @dd_data_size: driver host data size
2106 * @xmit_can_sleep: bool indicating if LLD will queue IO from a work queue
2108 * This should be called by partial offload and software iscsi drivers.
2109 * To access the driver specific memory use the iscsi_host_priv() macro.
2111 struct Scsi_Host *iscsi_host_alloc(struct scsi_host_template *sht,
2112 int dd_data_size, bool xmit_can_sleep)
2114 struct Scsi_Host *shost;
2115 struct iscsi_host *ihost;
2117 shost = scsi_host_alloc(sht, sizeof(struct iscsi_host) + dd_data_size);
2120 ihost = shost_priv(shost);
2122 if (xmit_can_sleep) {
2123 snprintf(ihost->workq_name, sizeof(ihost->workq_name),
2124 "iscsi_q_%d", shost->host_no);
2125 ihost->workq = create_singlethread_workqueue(ihost->workq_name);
2130 spin_lock_init(&ihost->lock);
2131 ihost->state = ISCSI_HOST_SETUP;
2132 ihost->num_sessions = 0;
2133 init_waitqueue_head(&ihost->session_removal_wq);
2137 scsi_host_put(shost);
2140 EXPORT_SYMBOL_GPL(iscsi_host_alloc);
2142 static void iscsi_notify_host_removed(struct iscsi_cls_session *cls_session)
2144 iscsi_session_failure(cls_session->dd_data, ISCSI_ERR_INVALID_HOST);
2148 * iscsi_host_remove - remove host and sessions
2151 * If there are any sessions left, this will initiate the removal and wait
2152 * for the completion.
2154 void iscsi_host_remove(struct Scsi_Host *shost)
2156 struct iscsi_host *ihost = shost_priv(shost);
2157 unsigned long flags;
2159 spin_lock_irqsave(&ihost->lock, flags);
2160 ihost->state = ISCSI_HOST_REMOVED;
2161 spin_unlock_irqrestore(&ihost->lock, flags);
2163 iscsi_host_for_each_session(shost, iscsi_notify_host_removed);
2164 wait_event_interruptible(ihost->session_removal_wq,
2165 ihost->num_sessions == 0);
2166 if (signal_pending(current))
2167 flush_signals(current);
2169 scsi_remove_host(shost);
2171 destroy_workqueue(ihost->workq);
2173 EXPORT_SYMBOL_GPL(iscsi_host_remove);
2175 void iscsi_host_free(struct Scsi_Host *shost)
2177 struct iscsi_host *ihost = shost_priv(shost);
2179 kfree(ihost->netdev);
2180 kfree(ihost->hwaddress);
2181 kfree(ihost->initiatorname);
2182 scsi_host_put(shost);
2184 EXPORT_SYMBOL_GPL(iscsi_host_free);
2186 static void iscsi_host_dec_session_cnt(struct Scsi_Host *shost)
2188 struct iscsi_host *ihost = shost_priv(shost);
2189 unsigned long flags;
2191 shost = scsi_host_get(shost);
2193 printk(KERN_ERR "Invalid state. Cannot notify host removal "
2194 "of session teardown event because host already "
2199 spin_lock_irqsave(&ihost->lock, flags);
2200 ihost->num_sessions--;
2201 if (ihost->num_sessions == 0)
2202 wake_up(&ihost->session_removal_wq);
2203 spin_unlock_irqrestore(&ihost->lock, flags);
2204 scsi_host_put(shost);
2208 * iscsi_session_setup - create iscsi cls session and host and session
2209 * @iscsit: iscsi transport template
2211 * @cmds_max: session can queue
2212 * @cmd_task_size: LLD task private data size
2213 * @initial_cmdsn: initial CmdSN
2215 * This can be used by software iscsi_transports that allocate
2216 * a session per scsi host.
2218 * Callers should set cmds_max to the largest total numer (mgmt + scsi) of
2219 * tasks they support. The iscsi layer reserves ISCSI_MGMT_CMDS_MAX tasks
2220 * for nop handling and login/logout requests.
2222 struct iscsi_cls_session *
2223 iscsi_session_setup(struct iscsi_transport *iscsit, struct Scsi_Host *shost,
2224 uint16_t cmds_max, int cmd_task_size,
2225 uint32_t initial_cmdsn, unsigned int id)
2227 struct iscsi_host *ihost = shost_priv(shost);
2228 struct iscsi_session *session;
2229 struct iscsi_cls_session *cls_session;
2230 int cmd_i, scsi_cmds, total_cmds = cmds_max;
2231 unsigned long flags;
2233 spin_lock_irqsave(&ihost->lock, flags);
2234 if (ihost->state == ISCSI_HOST_REMOVED) {
2235 spin_unlock_irqrestore(&ihost->lock, flags);
2238 ihost->num_sessions++;
2239 spin_unlock_irqrestore(&ihost->lock, flags);
2242 total_cmds = ISCSI_DEF_XMIT_CMDS_MAX;
2244 * The iscsi layer needs some tasks for nop handling and tmfs,
2245 * so the cmds_max must at least be greater than ISCSI_MGMT_CMDS_MAX
2246 * + 1 command for scsi IO.
2248 if (total_cmds < ISCSI_TOTAL_CMDS_MIN) {
2249 printk(KERN_ERR "iscsi: invalid can_queue of %d. can_queue "
2250 "must be a power of two that is at least %d.\n",
2251 total_cmds, ISCSI_TOTAL_CMDS_MIN);
2252 goto dec_session_count;
2255 if (total_cmds > ISCSI_TOTAL_CMDS_MAX) {
2256 printk(KERN_ERR "iscsi: invalid can_queue of %d. can_queue "
2257 "must be a power of 2 less than or equal to %d.\n",
2258 cmds_max, ISCSI_TOTAL_CMDS_MAX);
2259 total_cmds = ISCSI_TOTAL_CMDS_MAX;
2262 if (!is_power_of_2(total_cmds)) {
2263 printk(KERN_ERR "iscsi: invalid can_queue of %d. can_queue "
2264 "must be a power of 2.\n", total_cmds);
2265 total_cmds = rounddown_pow_of_two(total_cmds);
2266 if (total_cmds < ISCSI_TOTAL_CMDS_MIN)
2268 printk(KERN_INFO "iscsi: Rounding can_queue to %d.\n",
2271 scsi_cmds = total_cmds - ISCSI_MGMT_CMDS_MAX;
2273 cls_session = iscsi_alloc_session(shost, iscsit,
2274 sizeof(struct iscsi_session));
2276 goto dec_session_count;
2277 session = cls_session->dd_data;
2278 session->cls_session = cls_session;
2279 session->host = shost;
2280 session->state = ISCSI_STATE_FREE;
2281 session->fast_abort = 1;
2282 session->lu_reset_timeout = 15;
2283 session->abort_timeout = 10;
2284 session->scsi_cmds_max = scsi_cmds;
2285 session->cmds_max = total_cmds;
2286 session->queued_cmdsn = session->cmdsn = initial_cmdsn;
2287 session->exp_cmdsn = initial_cmdsn + 1;
2288 session->max_cmdsn = initial_cmdsn + 1;
2289 session->max_r2t = 1;
2290 session->tt = iscsit;
2291 mutex_init(&session->eh_mutex);
2292 spin_lock_init(&session->lock);
2294 /* initialize SCSI PDU commands pool */
2295 if (iscsi_pool_init(&session->cmdpool, session->cmds_max,
2296 (void***)&session->cmds,
2297 cmd_task_size + sizeof(struct iscsi_task)))
2298 goto cmdpool_alloc_fail;
2300 /* pre-format cmds pool with ITT */
2301 for (cmd_i = 0; cmd_i < session->cmds_max; cmd_i++) {
2302 struct iscsi_task *task = session->cmds[cmd_i];
2305 task->dd_data = &task[1];
2307 INIT_LIST_HEAD(&task->running);
2310 if (!try_module_get(iscsit->owner))
2311 goto module_get_fail;
2313 if (iscsi_add_session(cls_session, id))
2314 goto cls_session_fail;
2319 module_put(iscsit->owner);
2321 iscsi_pool_free(&session->cmdpool);
2323 iscsi_free_session(cls_session);
2325 iscsi_host_dec_session_cnt(shost);
2328 EXPORT_SYMBOL_GPL(iscsi_session_setup);
2331 * iscsi_session_teardown - destroy session, host, and cls_session
2332 * @cls_session: iscsi session
2334 * The driver must have called iscsi_remove_session before
2337 void iscsi_session_teardown(struct iscsi_cls_session *cls_session)
2339 struct iscsi_session *session = cls_session->dd_data;
2340 struct module *owner = cls_session->transport->owner;
2341 struct Scsi_Host *shost = session->host;
2343 iscsi_pool_free(&session->cmdpool);
2345 kfree(session->password);
2346 kfree(session->password_in);
2347 kfree(session->username);
2348 kfree(session->username_in);
2349 kfree(session->targetname);
2350 kfree(session->initiatorname);
2351 kfree(session->ifacename);
2353 iscsi_destroy_session(cls_session);
2354 iscsi_host_dec_session_cnt(shost);
2357 EXPORT_SYMBOL_GPL(iscsi_session_teardown);
2360 * iscsi_conn_setup - create iscsi_cls_conn and iscsi_conn
2361 * @cls_session: iscsi_cls_session
2362 * @dd_size: private driver data size
2365 struct iscsi_cls_conn *
2366 iscsi_conn_setup(struct iscsi_cls_session *cls_session, int dd_size,
2369 struct iscsi_session *session = cls_session->dd_data;
2370 struct iscsi_conn *conn;
2371 struct iscsi_cls_conn *cls_conn;
2374 cls_conn = iscsi_create_conn(cls_session, sizeof(*conn) + dd_size,
2378 conn = cls_conn->dd_data;
2379 memset(conn, 0, sizeof(*conn) + dd_size);
2381 conn->dd_data = cls_conn->dd_data + sizeof(*conn);
2382 conn->session = session;
2383 conn->cls_conn = cls_conn;
2384 conn->c_stage = ISCSI_CONN_INITIAL_STAGE;
2385 conn->id = conn_idx;
2386 conn->exp_statsn = 0;
2387 conn->tmf_state = TMF_INITIAL;
2389 init_timer(&conn->transport_timer);
2390 conn->transport_timer.data = (unsigned long)conn;
2391 conn->transport_timer.function = iscsi_check_transport_timeouts;
2393 INIT_LIST_HEAD(&conn->run_list);
2394 INIT_LIST_HEAD(&conn->mgmt_run_list);
2395 INIT_LIST_HEAD(&conn->mgmtqueue);
2396 INIT_LIST_HEAD(&conn->xmitqueue);
2397 INIT_LIST_HEAD(&conn->requeue);
2398 INIT_WORK(&conn->xmitwork, iscsi_xmitworker);
2400 /* allocate login_task used for the login/text sequences */
2401 spin_lock_bh(&session->lock);
2402 if (!__kfifo_get(session->cmdpool.queue,
2403 (void*)&conn->login_task,
2405 spin_unlock_bh(&session->lock);
2406 goto login_task_alloc_fail;
2408 spin_unlock_bh(&session->lock);
2410 data = (char *) __get_free_pages(GFP_KERNEL,
2411 get_order(ISCSI_DEF_MAX_RECV_SEG_LEN));
2413 goto login_task_data_alloc_fail;
2414 conn->login_task->data = conn->data = data;
2416 init_timer(&conn->tmf_timer);
2417 init_waitqueue_head(&conn->ehwait);
2421 login_task_data_alloc_fail:
2422 __kfifo_put(session->cmdpool.queue, (void*)&conn->login_task,
2424 login_task_alloc_fail:
2425 iscsi_destroy_conn(cls_conn);
2428 EXPORT_SYMBOL_GPL(iscsi_conn_setup);
2431 * iscsi_conn_teardown - teardown iscsi connection
2432 * cls_conn: iscsi class connection
2434 * TODO: we may need to make this into a two step process
2435 * like scsi-mls remove + put host
2437 void iscsi_conn_teardown(struct iscsi_cls_conn *cls_conn)
2439 struct iscsi_conn *conn = cls_conn->dd_data;
2440 struct iscsi_session *session = conn->session;
2441 unsigned long flags;
2443 del_timer_sync(&conn->transport_timer);
2445 spin_lock_bh(&session->lock);
2446 conn->c_stage = ISCSI_CONN_CLEANUP_WAIT;
2447 if (session->leadconn == conn) {
2449 * leading connection? then give up on recovery.
2451 session->state = ISCSI_STATE_TERMINATE;
2452 wake_up(&conn->ehwait);
2454 spin_unlock_bh(&session->lock);
2457 * Block until all in-progress commands for this connection
2461 spin_lock_irqsave(session->host->host_lock, flags);
2462 if (!session->host->host_busy) { /* OK for ERL == 0 */
2463 spin_unlock_irqrestore(session->host->host_lock, flags);
2466 spin_unlock_irqrestore(session->host->host_lock, flags);
2467 msleep_interruptible(500);
2468 iscsi_conn_printk(KERN_INFO, conn, "iscsi conn_destroy(): "
2469 "host_busy %d host_failed %d\n",
2470 session->host->host_busy,
2471 session->host->host_failed);
2473 * force eh_abort() to unblock
2475 wake_up(&conn->ehwait);
2478 /* flush queued up work because we free the connection below */
2479 iscsi_suspend_tx(conn);
2481 spin_lock_bh(&session->lock);
2482 free_pages((unsigned long) conn->data,
2483 get_order(ISCSI_DEF_MAX_RECV_SEG_LEN));
2484 kfree(conn->persistent_address);
2485 __kfifo_put(session->cmdpool.queue, (void*)&conn->login_task,
2487 if (session->leadconn == conn)
2488 session->leadconn = NULL;
2489 spin_unlock_bh(&session->lock);
2491 iscsi_destroy_conn(cls_conn);
2493 EXPORT_SYMBOL_GPL(iscsi_conn_teardown);
2495 int iscsi_conn_start(struct iscsi_cls_conn *cls_conn)
2497 struct iscsi_conn *conn = cls_conn->dd_data;
2498 struct iscsi_session *session = conn->session;
2501 iscsi_conn_printk(KERN_ERR, conn,
2502 "can't start unbound connection\n");
2506 if ((session->imm_data_en || !session->initial_r2t_en) &&
2507 session->first_burst > session->max_burst) {
2508 iscsi_conn_printk(KERN_INFO, conn, "invalid burst lengths: "
2509 "first_burst %d max_burst %d\n",
2510 session->first_burst, session->max_burst);
2514 if (conn->ping_timeout && !conn->recv_timeout) {
2515 iscsi_conn_printk(KERN_ERR, conn, "invalid recv timeout of "
2516 "zero. Using 5 seconds\n.");
2517 conn->recv_timeout = 5;
2520 if (conn->recv_timeout && !conn->ping_timeout) {
2521 iscsi_conn_printk(KERN_ERR, conn, "invalid ping timeout of "
2522 "zero. Using 5 seconds.\n");
2523 conn->ping_timeout = 5;
2526 spin_lock_bh(&session->lock);
2527 conn->c_stage = ISCSI_CONN_STARTED;
2528 session->state = ISCSI_STATE_LOGGED_IN;
2529 session->queued_cmdsn = session->cmdsn;
2531 conn->last_recv = jiffies;
2532 conn->last_ping = jiffies;
2533 if (conn->recv_timeout && conn->ping_timeout)
2534 mod_timer(&conn->transport_timer,
2535 jiffies + (conn->recv_timeout * HZ));
2537 switch(conn->stop_stage) {
2538 case STOP_CONN_RECOVER:
2540 * unblock eh_abort() if it is blocked. re-try all
2541 * commands after successful recovery
2543 conn->stop_stage = 0;
2544 conn->tmf_state = TMF_INITIAL;
2546 if (session->age == 16)
2549 case STOP_CONN_TERM:
2550 conn->stop_stage = 0;
2555 spin_unlock_bh(&session->lock);
2557 iscsi_unblock_session(session->cls_session);
2558 wake_up(&conn->ehwait);
2561 EXPORT_SYMBOL_GPL(iscsi_conn_start);
2564 flush_control_queues(struct iscsi_session *session, struct iscsi_conn *conn)
2566 struct iscsi_task *task, *tmp;
2568 /* handle pending */
2569 list_for_each_entry_safe(task, tmp, &conn->mgmtqueue, running) {
2570 ISCSI_DBG_SESSION(session, "flushing pending mgmt task "
2571 "itt 0x%x\n", task->itt);
2572 /* release ref from prep task */
2573 __iscsi_put_task(task);
2576 /* handle running */
2577 list_for_each_entry_safe(task, tmp, &conn->mgmt_run_list, running) {
2578 ISCSI_DBG_SESSION(session, "flushing running mgmt task "
2579 "itt 0x%x\n", task->itt);
2580 /* release ref from prep task */
2581 __iscsi_put_task(task);
2587 static void iscsi_start_session_recovery(struct iscsi_session *session,
2588 struct iscsi_conn *conn, int flag)
2592 mutex_lock(&session->eh_mutex);
2593 spin_lock_bh(&session->lock);
2594 if (conn->stop_stage == STOP_CONN_TERM) {
2595 spin_unlock_bh(&session->lock);
2596 mutex_unlock(&session->eh_mutex);
2601 * When this is called for the in_login state, we only want to clean
2602 * up the login task and connection. We do not need to block and set
2603 * the recovery state again
2605 if (flag == STOP_CONN_TERM)
2606 session->state = ISCSI_STATE_TERMINATE;
2607 else if (conn->stop_stage != STOP_CONN_RECOVER)
2608 session->state = ISCSI_STATE_IN_RECOVERY;
2609 spin_unlock_bh(&session->lock);
2611 del_timer_sync(&conn->transport_timer);
2612 iscsi_suspend_tx(conn);
2614 spin_lock_bh(&session->lock);
2615 old_stop_stage = conn->stop_stage;
2616 conn->stop_stage = flag;
2617 conn->c_stage = ISCSI_CONN_STOPPED;
2618 spin_unlock_bh(&session->lock);
2621 * for connection level recovery we should not calculate
2622 * header digest. conn->hdr_size used for optimization
2623 * in hdr_extract() and will be re-negotiated at
2626 if (flag == STOP_CONN_RECOVER) {
2627 conn->hdrdgst_en = 0;
2628 conn->datadgst_en = 0;
2629 if (session->state == ISCSI_STATE_IN_RECOVERY &&
2630 old_stop_stage != STOP_CONN_RECOVER) {
2631 ISCSI_DBG_SESSION(session, "blocking session\n");
2632 iscsi_block_session(session->cls_session);
2639 spin_lock_bh(&session->lock);
2640 if (flag == STOP_CONN_RECOVER)
2641 fail_all_commands(conn, -1, DID_TRANSPORT_DISRUPTED);
2643 fail_all_commands(conn, -1, DID_ERROR);
2644 flush_control_queues(session, conn);
2645 spin_unlock_bh(&session->lock);
2646 mutex_unlock(&session->eh_mutex);
2649 void iscsi_conn_stop(struct iscsi_cls_conn *cls_conn, int flag)
2651 struct iscsi_conn *conn = cls_conn->dd_data;
2652 struct iscsi_session *session = conn->session;
2655 case STOP_CONN_RECOVER:
2656 case STOP_CONN_TERM:
2657 iscsi_start_session_recovery(session, conn, flag);
2660 iscsi_conn_printk(KERN_ERR, conn,
2661 "invalid stop flag %d\n", flag);
2664 EXPORT_SYMBOL_GPL(iscsi_conn_stop);
2666 int iscsi_conn_bind(struct iscsi_cls_session *cls_session,
2667 struct iscsi_cls_conn *cls_conn, int is_leading)
2669 struct iscsi_session *session = cls_session->dd_data;
2670 struct iscsi_conn *conn = cls_conn->dd_data;
2672 spin_lock_bh(&session->lock);
2674 session->leadconn = conn;
2675 spin_unlock_bh(&session->lock);
2678 * Unblock xmitworker(), Login Phase will pass through.
2680 clear_bit(ISCSI_SUSPEND_BIT, &conn->suspend_rx);
2681 clear_bit(ISCSI_SUSPEND_BIT, &conn->suspend_tx);
2684 EXPORT_SYMBOL_GPL(iscsi_conn_bind);
2686 static int iscsi_switch_str_param(char **param, char *new_val_buf)
2691 if (!strcmp(*param, new_val_buf))
2695 new_val = kstrdup(new_val_buf, GFP_NOIO);
2704 int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
2705 enum iscsi_param param, char *buf, int buflen)
2707 struct iscsi_conn *conn = cls_conn->dd_data;
2708 struct iscsi_session *session = conn->session;
2712 case ISCSI_PARAM_FAST_ABORT:
2713 sscanf(buf, "%d", &session->fast_abort);
2715 case ISCSI_PARAM_ABORT_TMO:
2716 sscanf(buf, "%d", &session->abort_timeout);
2718 case ISCSI_PARAM_LU_RESET_TMO:
2719 sscanf(buf, "%d", &session->lu_reset_timeout);
2721 case ISCSI_PARAM_PING_TMO:
2722 sscanf(buf, "%d", &conn->ping_timeout);
2724 case ISCSI_PARAM_RECV_TMO:
2725 sscanf(buf, "%d", &conn->recv_timeout);
2727 case ISCSI_PARAM_MAX_RECV_DLENGTH:
2728 sscanf(buf, "%d", &conn->max_recv_dlength);
2730 case ISCSI_PARAM_MAX_XMIT_DLENGTH:
2731 sscanf(buf, "%d", &conn->max_xmit_dlength);
2733 case ISCSI_PARAM_HDRDGST_EN:
2734 sscanf(buf, "%d", &conn->hdrdgst_en);
2736 case ISCSI_PARAM_DATADGST_EN:
2737 sscanf(buf, "%d", &conn->datadgst_en);
2739 case ISCSI_PARAM_INITIAL_R2T_EN:
2740 sscanf(buf, "%d", &session->initial_r2t_en);
2742 case ISCSI_PARAM_MAX_R2T:
2743 sscanf(buf, "%d", &session->max_r2t);
2745 case ISCSI_PARAM_IMM_DATA_EN:
2746 sscanf(buf, "%d", &session->imm_data_en);
2748 case ISCSI_PARAM_FIRST_BURST:
2749 sscanf(buf, "%d", &session->first_burst);
2751 case ISCSI_PARAM_MAX_BURST:
2752 sscanf(buf, "%d", &session->max_burst);
2754 case ISCSI_PARAM_PDU_INORDER_EN:
2755 sscanf(buf, "%d", &session->pdu_inorder_en);
2757 case ISCSI_PARAM_DATASEQ_INORDER_EN:
2758 sscanf(buf, "%d", &session->dataseq_inorder_en);
2760 case ISCSI_PARAM_ERL:
2761 sscanf(buf, "%d", &session->erl);
2763 case ISCSI_PARAM_IFMARKER_EN:
2764 sscanf(buf, "%d", &value);
2767 case ISCSI_PARAM_OFMARKER_EN:
2768 sscanf(buf, "%d", &value);
2771 case ISCSI_PARAM_EXP_STATSN:
2772 sscanf(buf, "%u", &conn->exp_statsn);
2774 case ISCSI_PARAM_USERNAME:
2775 return iscsi_switch_str_param(&session->username, buf);
2776 case ISCSI_PARAM_USERNAME_IN:
2777 return iscsi_switch_str_param(&session->username_in, buf);
2778 case ISCSI_PARAM_PASSWORD:
2779 return iscsi_switch_str_param(&session->password, buf);
2780 case ISCSI_PARAM_PASSWORD_IN:
2781 return iscsi_switch_str_param(&session->password_in, buf);
2782 case ISCSI_PARAM_TARGET_NAME:
2783 return iscsi_switch_str_param(&session->targetname, buf);
2784 case ISCSI_PARAM_TPGT:
2785 sscanf(buf, "%d", &session->tpgt);
2787 case ISCSI_PARAM_PERSISTENT_PORT:
2788 sscanf(buf, "%d", &conn->persistent_port);
2790 case ISCSI_PARAM_PERSISTENT_ADDRESS:
2791 return iscsi_switch_str_param(&conn->persistent_address, buf);
2792 case ISCSI_PARAM_IFACE_NAME:
2793 return iscsi_switch_str_param(&session->ifacename, buf);
2794 case ISCSI_PARAM_INITIATOR_NAME:
2795 return iscsi_switch_str_param(&session->initiatorname, buf);
2802 EXPORT_SYMBOL_GPL(iscsi_set_param);
2804 int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
2805 enum iscsi_param param, char *buf)
2807 struct iscsi_session *session = cls_session->dd_data;
2811 case ISCSI_PARAM_FAST_ABORT:
2812 len = sprintf(buf, "%d\n", session->fast_abort);
2814 case ISCSI_PARAM_ABORT_TMO:
2815 len = sprintf(buf, "%d\n", session->abort_timeout);
2817 case ISCSI_PARAM_LU_RESET_TMO:
2818 len = sprintf(buf, "%d\n", session->lu_reset_timeout);
2820 case ISCSI_PARAM_INITIAL_R2T_EN:
2821 len = sprintf(buf, "%d\n", session->initial_r2t_en);
2823 case ISCSI_PARAM_MAX_R2T:
2824 len = sprintf(buf, "%hu\n", session->max_r2t);
2826 case ISCSI_PARAM_IMM_DATA_EN:
2827 len = sprintf(buf, "%d\n", session->imm_data_en);
2829 case ISCSI_PARAM_FIRST_BURST:
2830 len = sprintf(buf, "%u\n", session->first_burst);
2832 case ISCSI_PARAM_MAX_BURST:
2833 len = sprintf(buf, "%u\n", session->max_burst);
2835 case ISCSI_PARAM_PDU_INORDER_EN:
2836 len = sprintf(buf, "%d\n", session->pdu_inorder_en);
2838 case ISCSI_PARAM_DATASEQ_INORDER_EN:
2839 len = sprintf(buf, "%d\n", session->dataseq_inorder_en);
2841 case ISCSI_PARAM_ERL:
2842 len = sprintf(buf, "%d\n", session->erl);
2844 case ISCSI_PARAM_TARGET_NAME:
2845 len = sprintf(buf, "%s\n", session->targetname);
2847 case ISCSI_PARAM_TPGT:
2848 len = sprintf(buf, "%d\n", session->tpgt);
2850 case ISCSI_PARAM_USERNAME:
2851 len = sprintf(buf, "%s\n", session->username);
2853 case ISCSI_PARAM_USERNAME_IN:
2854 len = sprintf(buf, "%s\n", session->username_in);
2856 case ISCSI_PARAM_PASSWORD:
2857 len = sprintf(buf, "%s\n", session->password);
2859 case ISCSI_PARAM_PASSWORD_IN:
2860 len = sprintf(buf, "%s\n", session->password_in);
2862 case ISCSI_PARAM_IFACE_NAME:
2863 len = sprintf(buf, "%s\n", session->ifacename);
2865 case ISCSI_PARAM_INITIATOR_NAME:
2866 len = sprintf(buf, "%s\n", session->initiatorname);
2874 EXPORT_SYMBOL_GPL(iscsi_session_get_param);
2876 int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
2877 enum iscsi_param param, char *buf)
2879 struct iscsi_conn *conn = cls_conn->dd_data;
2883 case ISCSI_PARAM_PING_TMO:
2884 len = sprintf(buf, "%u\n", conn->ping_timeout);
2886 case ISCSI_PARAM_RECV_TMO:
2887 len = sprintf(buf, "%u\n", conn->recv_timeout);
2889 case ISCSI_PARAM_MAX_RECV_DLENGTH:
2890 len = sprintf(buf, "%u\n", conn->max_recv_dlength);
2892 case ISCSI_PARAM_MAX_XMIT_DLENGTH:
2893 len = sprintf(buf, "%u\n", conn->max_xmit_dlength);
2895 case ISCSI_PARAM_HDRDGST_EN:
2896 len = sprintf(buf, "%d\n", conn->hdrdgst_en);
2898 case ISCSI_PARAM_DATADGST_EN:
2899 len = sprintf(buf, "%d\n", conn->datadgst_en);
2901 case ISCSI_PARAM_IFMARKER_EN:
2902 len = sprintf(buf, "%d\n", conn->ifmarker_en);
2904 case ISCSI_PARAM_OFMARKER_EN:
2905 len = sprintf(buf, "%d\n", conn->ofmarker_en);
2907 case ISCSI_PARAM_EXP_STATSN:
2908 len = sprintf(buf, "%u\n", conn->exp_statsn);
2910 case ISCSI_PARAM_PERSISTENT_PORT:
2911 len = sprintf(buf, "%d\n", conn->persistent_port);
2913 case ISCSI_PARAM_PERSISTENT_ADDRESS:
2914 len = sprintf(buf, "%s\n", conn->persistent_address);
2922 EXPORT_SYMBOL_GPL(iscsi_conn_get_param);
2924 int iscsi_host_get_param(struct Scsi_Host *shost, enum iscsi_host_param param,
2927 struct iscsi_host *ihost = shost_priv(shost);
2931 case ISCSI_HOST_PARAM_NETDEV_NAME:
2932 len = sprintf(buf, "%s\n", ihost->netdev);
2934 case ISCSI_HOST_PARAM_HWADDRESS:
2935 len = sprintf(buf, "%s\n", ihost->hwaddress);
2937 case ISCSI_HOST_PARAM_INITIATOR_NAME:
2938 len = sprintf(buf, "%s\n", ihost->initiatorname);
2940 case ISCSI_HOST_PARAM_IPADDRESS:
2941 len = sprintf(buf, "%s\n", ihost->local_address);
2949 EXPORT_SYMBOL_GPL(iscsi_host_get_param);
2951 int iscsi_host_set_param(struct Scsi_Host *shost, enum iscsi_host_param param,
2952 char *buf, int buflen)
2954 struct iscsi_host *ihost = shost_priv(shost);
2957 case ISCSI_HOST_PARAM_NETDEV_NAME:
2958 return iscsi_switch_str_param(&ihost->netdev, buf);
2959 case ISCSI_HOST_PARAM_HWADDRESS:
2960 return iscsi_switch_str_param(&ihost->hwaddress, buf);
2961 case ISCSI_HOST_PARAM_INITIATOR_NAME:
2962 return iscsi_switch_str_param(&ihost->initiatorname, buf);
2969 EXPORT_SYMBOL_GPL(iscsi_host_set_param);
2971 MODULE_AUTHOR("Mike Christie");
2972 MODULE_DESCRIPTION("iSCSI library functions");
2973 MODULE_LICENSE("GPL");