2 * iSCSI Initiator over iSER Data-Path
4 * Copyright (C) 2004 Dmitry Yusupov
5 * Copyright (C) 2004 Alex Aizman
6 * Copyright (C) 2005 Mike Christie
7 * Copyright (c) 2005, 2006 Voltaire, Inc. All rights reserved.
8 * maintained by openib-general@openib.org
10 * This software is available to you under a choice of one of two
11 * licenses. You may choose to be licensed under the terms of the GNU
12 * General Public License (GPL) Version 2, available from the file
13 * COPYING in the main directory of this source tree, or the
14 * OpenIB.org BSD license below:
16 * Redistribution and use in source and binary forms, with or
17 * without modification, are permitted provided that the following
20 * - Redistributions of source code must retain the above
21 * copyright notice, this list of conditions and the following
24 * - Redistributions in binary form must reproduce the above
25 * copyright notice, this list of conditions and the following
26 * disclaimer in the documentation and/or other materials
27 * provided with the distribution.
29 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
33 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
34 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
35 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
47 #include <linux/types.h>
48 #include <linux/list.h>
49 #include <linux/hardirq.h>
50 #include <linux/kfifo.h>
51 #include <linux/blkdev.h>
52 #include <linux/init.h>
53 #include <linux/ioctl.h>
54 #include <linux/cdev.h>
56 #include <linux/net.h>
57 #include <linux/scatterlist.h>
58 #include <linux/delay.h>
62 #include <asm/uaccess.h>
64 #include <scsi/scsi_cmnd.h>
65 #include <scsi/scsi_device.h>
66 #include <scsi/scsi_eh.h>
67 #include <scsi/scsi_tcq.h>
68 #include <scsi/scsi_host.h>
69 #include <scsi/scsi.h>
70 #include <scsi/scsi_transport_iscsi.h>
72 #include "iscsi_iser.h"
74 static struct scsi_host_template iscsi_iser_sht;
75 static struct iscsi_transport iscsi_iser_transport;
76 static struct scsi_transport_template *iscsi_iser_scsi_transport;
78 static unsigned int iscsi_max_lun = 512;
79 module_param_named(max_lun, iscsi_max_lun, uint, S_IRUGO);
81 int iser_debug_level = 0;
83 MODULE_DESCRIPTION("iSER (iSCSI Extensions for RDMA) Datamover "
84 "v" DRV_VER " (" DRV_DATE ")");
85 MODULE_LICENSE("Dual BSD/GPL");
86 MODULE_AUTHOR("Alex Nezhinsky, Dan Bar Dov, Or Gerlitz");
88 module_param_named(debug_level, iser_debug_level, int, 0644);
89 MODULE_PARM_DESC(debug_level, "Enable debug tracing if > 0 (default:disabled)");
91 struct iser_global ig;
94 iscsi_iser_recv(struct iscsi_conn *conn,
95 struct iscsi_hdr *hdr, char *rx_data, int rx_data_len)
101 /* verify PDU length */
102 datalen = ntoh24(hdr->dlength);
103 if (datalen != rx_data_len) {
104 printk(KERN_ERR "iscsi_iser: datalen %d (hdr) != %d (IB) \n",
105 datalen, rx_data_len);
106 rc = ISCSI_ERR_DATALEN;
111 ahslen = hdr->hlength * 4;
113 rc = iscsi_complete_pdu(conn, hdr, rx_data, rx_data_len);
114 if (rc && rc != ISCSI_ERR_NO_SCSI_CMD)
119 iscsi_conn_failure(conn, rc);
124 * iscsi_iser_task_init - Initialize task
127 * Initialize the task for the scsi command or mgmt command.
130 iscsi_iser_task_init(struct iscsi_task *task)
132 struct iscsi_iser_conn *iser_conn = task->conn->dd_data;
133 struct iscsi_iser_task *iser_task = task->dd_data;
137 iser_task->desc.data = task->data;
141 iser_task->command_sent = 0;
142 iser_task->iser_conn = iser_conn;
143 iser_task_rdma_init(iser_task);
148 * iscsi_iser_mtask_xmit - xmit management(immediate) task
149 * @conn: iscsi connection
150 * @task: task management task
153 * The function can return -EAGAIN in which case caller must
154 * call it again later, or recover. '0' return code means successful
159 iscsi_iser_mtask_xmit(struct iscsi_conn *conn, struct iscsi_task *task)
163 debug_scsi("task deq [cid %d itt 0x%x]\n", conn->id, task->itt);
165 error = iser_send_control(conn, task);
167 /* since iser xmits control with zero copy, tasks can not be recycled
168 * right after sending them.
169 * The recycling scheme is based on whether a response is expected
170 * - if yes, the task is recycled at iscsi_complete_pdu
171 * - if no, the task is recycled at iser_snd_completion
173 if (error && error != -ENOBUFS)
174 iscsi_conn_failure(conn, ISCSI_ERR_CONN_FAILED);
180 iscsi_iser_task_xmit_unsol_data(struct iscsi_conn *conn,
181 struct iscsi_task *task)
183 struct iscsi_data hdr;
186 /* Send data-out PDUs while there's still unsolicited data to send */
187 while (task->unsol_count > 0) {
188 iscsi_prep_unsolicit_data_pdu(task, &hdr);
189 debug_scsi("Sending data-out: itt 0x%x, data count %d\n",
190 hdr.itt, task->data_count);
192 /* the buffer description has been passed with the command */
193 /* Send the command */
194 error = iser_send_data_out(conn, task, &hdr);
196 task->unsol_datasn--;
197 goto iscsi_iser_task_xmit_unsol_data_exit;
199 task->unsol_count -= task->data_count;
200 debug_scsi("Need to send %d more as data-out PDUs\n",
204 iscsi_iser_task_xmit_unsol_data_exit:
209 iscsi_iser_task_xmit(struct iscsi_task *task)
211 struct iscsi_conn *conn = task->conn;
212 struct iscsi_iser_task *iser_task = task->dd_data;
216 return iscsi_iser_mtask_xmit(conn, task);
218 if (task->sc->sc_data_direction == DMA_TO_DEVICE) {
219 BUG_ON(scsi_bufflen(task->sc) == 0);
221 debug_scsi("cmd [itt %x total %d imm %d unsol_data %d\n",
222 task->itt, scsi_bufflen(task->sc),
223 task->imm_count, task->unsol_count);
226 debug_scsi("task deq [cid %d itt 0x%x]\n",
227 conn->id, task->itt);
229 /* Send the cmd PDU */
230 if (!iser_task->command_sent) {
231 error = iser_send_command(conn, task);
233 goto iscsi_iser_task_xmit_exit;
234 iser_task->command_sent = 1;
237 /* Send unsolicited data-out PDU(s) if necessary */
238 if (task->unsol_count)
239 error = iscsi_iser_task_xmit_unsol_data(conn, task);
241 iscsi_iser_task_xmit_exit:
242 if (error && error != -ENOBUFS)
243 iscsi_conn_failure(conn, ISCSI_ERR_CONN_FAILED);
248 iscsi_iser_cleanup_task(struct iscsi_conn *conn, struct iscsi_task *task)
250 struct iscsi_iser_task *iser_task = task->dd_data;
252 /* mgmt tasks do not need special cleanup */
256 if (iser_task->status == ISER_TASK_STATUS_STARTED) {
257 iser_task->status = ISER_TASK_STATUS_COMPLETED;
258 iser_task_rdma_finalize(iser_task);
262 static struct iscsi_cls_conn *
263 iscsi_iser_conn_create(struct iscsi_cls_session *cls_session, uint32_t conn_idx)
265 struct iscsi_conn *conn;
266 struct iscsi_cls_conn *cls_conn;
267 struct iscsi_iser_conn *iser_conn;
269 cls_conn = iscsi_conn_setup(cls_session, sizeof(*iser_conn), conn_idx);
272 conn = cls_conn->dd_data;
275 * due to issues with the login code re iser sematics
276 * this not set in iscsi_conn_setup - FIXME
278 conn->max_recv_dlength = 128;
280 iser_conn = conn->dd_data;
281 conn->dd_data = iser_conn;
282 iser_conn->iscsi_conn = conn;
288 iscsi_iser_conn_destroy(struct iscsi_cls_conn *cls_conn)
290 struct iscsi_conn *conn = cls_conn->dd_data;
291 struct iscsi_iser_conn *iser_conn = conn->dd_data;
292 struct iser_conn *ib_conn = iser_conn->ib_conn;
294 iscsi_conn_teardown(cls_conn);
296 * Userspace will normally call the stop callback and
297 * already have freed the ib_conn, but if it goofed up then
301 ib_conn->iser_conn = NULL;
302 iser_conn_put(ib_conn);
307 iscsi_iser_conn_bind(struct iscsi_cls_session *cls_session,
308 struct iscsi_cls_conn *cls_conn, uint64_t transport_eph,
311 struct iscsi_conn *conn = cls_conn->dd_data;
312 struct iscsi_iser_conn *iser_conn;
313 struct iser_conn *ib_conn;
314 struct iscsi_endpoint *ep;
317 error = iscsi_conn_bind(cls_session, cls_conn, is_leading);
321 /* the transport ep handle comes from user space so it must be
322 * verified against the global ib connections list */
323 ep = iscsi_lookup_endpoint(transport_eph);
325 iser_err("can't bind eph %llx\n",
326 (unsigned long long)transport_eph);
329 ib_conn = ep->dd_data;
331 /* binds the iSER connection retrieved from the previously
332 * connected ep_handle to the iSCSI layer connection. exchanges
333 * connection pointers */
334 iser_err("binding iscsi conn %p to iser_conn %p\n",conn,ib_conn);
335 iser_conn = conn->dd_data;
336 ib_conn->iser_conn = iser_conn;
337 iser_conn->ib_conn = ib_conn;
338 iser_conn_get(ib_conn);
343 iscsi_iser_conn_stop(struct iscsi_cls_conn *cls_conn, int flag)
345 struct iscsi_conn *conn = cls_conn->dd_data;
346 struct iscsi_iser_conn *iser_conn = conn->dd_data;
347 struct iser_conn *ib_conn = iser_conn->ib_conn;
350 * Userspace may have goofed up and not bound the connection or
351 * might have only partially setup the connection.
354 iscsi_conn_stop(cls_conn, flag);
356 * There is no unbind event so the stop callback
357 * must release the ref from the bind.
359 iser_conn_put(ib_conn);
361 iser_conn->ib_conn = NULL;
365 iscsi_iser_conn_start(struct iscsi_cls_conn *cls_conn)
367 struct iscsi_conn *conn = cls_conn->dd_data;
370 err = iser_conn_set_full_featured_mode(conn);
374 return iscsi_conn_start(cls_conn);
377 static void iscsi_iser_session_destroy(struct iscsi_cls_session *cls_session)
379 struct Scsi_Host *shost = iscsi_session_to_shost(cls_session);
381 iscsi_host_remove(shost);
382 iscsi_host_free(shost);
385 static struct iscsi_cls_session *
386 iscsi_iser_session_create(struct iscsi_endpoint *ep,
387 uint16_t cmds_max, uint16_t qdepth,
388 uint32_t initial_cmdsn, uint32_t *hostno)
390 struct iscsi_cls_session *cls_session;
391 struct iscsi_session *session;
392 struct Scsi_Host *shost;
394 struct iscsi_task *task;
395 struct iscsi_iser_task *iser_task;
396 struct iser_conn *ib_conn;
398 shost = iscsi_host_alloc(&iscsi_iser_sht, 0, ISCSI_MAX_CMD_PER_LUN);
401 shost->transportt = iscsi_iser_scsi_transport;
402 shost->max_lun = iscsi_max_lun;
404 shost->max_channel = 0;
405 shost->max_cmd_len = 16;
408 * older userspace tools (before 2.0-870) did not pass us
409 * the leading conn's ep so this will be NULL;
412 ib_conn = ep->dd_data;
414 if (iscsi_host_add(shost,
415 ep ? ib_conn->device->ib_device->dma_device : NULL))
417 *hostno = shost->host_no;
420 * we do not support setting can_queue cmd_per_lun from userspace yet
421 * because we preallocate so many resources
423 cls_session = iscsi_session_setup(&iscsi_iser_transport, shost,
424 ISCSI_DEF_XMIT_CMDS_MAX,
425 sizeof(struct iscsi_iser_task),
429 session = cls_session->dd_data;
431 shost->can_queue = session->scsi_cmds_max;
432 /* libiscsi setup itts, data and pool so just set desc fields */
433 for (i = 0; i < session->cmds_max; i++) {
434 task = session->cmds[i];
435 iser_task = task->dd_data;
436 task->hdr = (struct iscsi_cmd *)&iser_task->desc.iscsi_header;
437 task->hdr_max = sizeof(iser_task->desc.iscsi_header);
442 iscsi_host_remove(shost);
444 iscsi_host_free(shost);
449 iscsi_iser_set_param(struct iscsi_cls_conn *cls_conn,
450 enum iscsi_param param, char *buf, int buflen)
455 case ISCSI_PARAM_MAX_RECV_DLENGTH:
458 case ISCSI_PARAM_HDRDGST_EN:
459 sscanf(buf, "%d", &value);
461 printk(KERN_ERR "DataDigest wasn't negotiated to None");
465 case ISCSI_PARAM_DATADGST_EN:
466 sscanf(buf, "%d", &value);
468 printk(KERN_ERR "DataDigest wasn't negotiated to None");
472 case ISCSI_PARAM_IFMARKER_EN:
473 sscanf(buf, "%d", &value);
475 printk(KERN_ERR "IFMarker wasn't negotiated to No");
479 case ISCSI_PARAM_OFMARKER_EN:
480 sscanf(buf, "%d", &value);
482 printk(KERN_ERR "OFMarker wasn't negotiated to No");
487 return iscsi_set_param(cls_conn, param, buf, buflen);
494 iscsi_iser_conn_get_stats(struct iscsi_cls_conn *cls_conn, struct iscsi_stats *stats)
496 struct iscsi_conn *conn = cls_conn->dd_data;
498 stats->txdata_octets = conn->txdata_octets;
499 stats->rxdata_octets = conn->rxdata_octets;
500 stats->scsicmd_pdus = conn->scsicmd_pdus_cnt;
501 stats->dataout_pdus = conn->dataout_pdus_cnt;
502 stats->scsirsp_pdus = conn->scsirsp_pdus_cnt;
503 stats->datain_pdus = conn->datain_pdus_cnt; /* always 0 */
504 stats->r2t_pdus = conn->r2t_pdus_cnt; /* always 0 */
505 stats->tmfcmd_pdus = conn->tmfcmd_pdus_cnt;
506 stats->tmfrsp_pdus = conn->tmfrsp_pdus_cnt;
507 stats->custom_length = 4;
508 strcpy(stats->custom[0].desc, "qp_tx_queue_full");
509 stats->custom[0].value = 0; /* TB iser_conn->qp_tx_queue_full; */
510 strcpy(stats->custom[1].desc, "fmr_map_not_avail");
511 stats->custom[1].value = 0; /* TB iser_conn->fmr_map_not_avail */;
512 strcpy(stats->custom[2].desc, "eh_abort_cnt");
513 stats->custom[2].value = conn->eh_abort_cnt;
514 strcpy(stats->custom[3].desc, "fmr_unalign_cnt");
515 stats->custom[3].value = conn->fmr_unalign_cnt;
518 static struct iscsi_endpoint *
519 iscsi_iser_ep_connect(struct sockaddr *dst_addr, int non_blocking)
522 struct iser_conn *ib_conn;
523 struct iscsi_endpoint *ep;
525 ep = iscsi_create_endpoint(sizeof(*ib_conn));
527 return ERR_PTR(-ENOMEM);
529 ib_conn = ep->dd_data;
531 iser_conn_init(ib_conn);
533 err = iser_connect(ib_conn, NULL, (struct sockaddr_in *)dst_addr,
536 iscsi_destroy_endpoint(ep);
543 iscsi_iser_ep_poll(struct iscsi_endpoint *ep, int timeout_ms)
545 struct iser_conn *ib_conn;
548 ib_conn = ep->dd_data;
549 rc = wait_event_interruptible_timeout(ib_conn->wait,
550 ib_conn->state == ISER_CONN_UP,
551 msecs_to_jiffies(timeout_ms));
553 /* if conn establishment failed, return error code to iscsi */
555 (ib_conn->state == ISER_CONN_TERMINATING ||
556 ib_conn->state == ISER_CONN_DOWN))
559 iser_err("ib conn %p rc = %d\n", ib_conn, rc);
562 return 1; /* success, this is the equivalent of POLLOUT */
564 return 0; /* timeout */
566 return rc; /* signal */
570 iscsi_iser_ep_disconnect(struct iscsi_endpoint *ep)
572 struct iser_conn *ib_conn;
574 ib_conn = ep->dd_data;
575 if (ib_conn->iser_conn)
577 * Must suspend xmit path if the ep is bound to the
578 * iscsi_conn, so we know we are not accessing the ib_conn
581 * This may not be bound if the ep poll failed.
583 iscsi_suspend_tx(ib_conn->iser_conn->iscsi_conn);
586 iser_err("ib conn %p state %d\n",ib_conn, ib_conn->state);
587 iser_conn_terminate(ib_conn);
590 static struct scsi_host_template iscsi_iser_sht = {
591 .module = THIS_MODULE,
592 .name = "iSCSI Initiator over iSER, v." DRV_VER,
593 .queuecommand = iscsi_queuecommand,
594 .change_queue_depth = iscsi_change_queue_depth,
595 .sg_tablesize = ISCSI_ISER_SG_TABLESIZE,
597 .cmd_per_lun = ISCSI_MAX_CMD_PER_LUN,
598 .eh_abort_handler = iscsi_eh_abort,
599 .eh_device_reset_handler= iscsi_eh_device_reset,
600 .eh_host_reset_handler = iscsi_eh_host_reset,
601 .use_clustering = DISABLE_CLUSTERING,
602 .proc_name = "iscsi_iser",
606 static struct iscsi_transport iscsi_iser_transport = {
607 .owner = THIS_MODULE,
609 .caps = CAP_RECOVERY_L0 | CAP_MULTI_R2T,
610 .param_mask = ISCSI_MAX_RECV_DLENGTH |
611 ISCSI_MAX_XMIT_DLENGTH |
614 ISCSI_INITIAL_R2T_EN |
619 ISCSI_PDU_INORDER_EN |
620 ISCSI_DATASEQ_INORDER_EN |
622 ISCSI_PERSISTENT_PORT |
623 ISCSI_PERSISTENT_ADDRESS |
624 ISCSI_TARGET_NAME | ISCSI_TPGT |
625 ISCSI_USERNAME | ISCSI_PASSWORD |
626 ISCSI_USERNAME_IN | ISCSI_PASSWORD_IN |
627 ISCSI_FAST_ABORT | ISCSI_ABORT_TMO |
628 ISCSI_PING_TMO | ISCSI_RECV_TMO |
629 ISCSI_IFACE_NAME | ISCSI_INITIATOR_NAME,
630 .host_param_mask = ISCSI_HOST_HWADDRESS |
631 ISCSI_HOST_NETDEV_NAME |
632 ISCSI_HOST_INITIATOR_NAME,
633 /* session management */
634 .create_session = iscsi_iser_session_create,
635 .destroy_session = iscsi_iser_session_destroy,
636 /* connection management */
637 .create_conn = iscsi_iser_conn_create,
638 .bind_conn = iscsi_iser_conn_bind,
639 .destroy_conn = iscsi_iser_conn_destroy,
640 .set_param = iscsi_iser_set_param,
641 .get_conn_param = iscsi_conn_get_param,
642 .get_session_param = iscsi_session_get_param,
643 .start_conn = iscsi_iser_conn_start,
644 .stop_conn = iscsi_iser_conn_stop,
645 /* iscsi host params */
646 .get_host_param = iscsi_host_get_param,
647 .set_host_param = iscsi_host_set_param,
649 .send_pdu = iscsi_conn_send_pdu,
650 .get_stats = iscsi_iser_conn_get_stats,
651 .init_task = iscsi_iser_task_init,
652 .xmit_task = iscsi_iser_task_xmit,
653 .cleanup_task = iscsi_iser_cleanup_task,
655 .session_recovery_timedout = iscsi_session_recovery_timedout,
657 .ep_connect = iscsi_iser_ep_connect,
658 .ep_poll = iscsi_iser_ep_poll,
659 .ep_disconnect = iscsi_iser_ep_disconnect
662 static int __init iser_init(void)
666 iser_dbg("Starting iSER datamover...\n");
668 if (iscsi_max_lun < 1) {
669 printk(KERN_ERR "Invalid max_lun value of %u\n", iscsi_max_lun);
673 memset(&ig, 0, sizeof(struct iser_global));
675 ig.desc_cache = kmem_cache_create("iser_descriptors",
676 sizeof (struct iser_desc),
677 0, SLAB_HWCACHE_ALIGN,
679 if (ig.desc_cache == NULL)
682 /* device init is called only after the first addr resolution */
683 mutex_init(&ig.device_list_mutex);
684 INIT_LIST_HEAD(&ig.device_list);
685 mutex_init(&ig.connlist_mutex);
686 INIT_LIST_HEAD(&ig.connlist);
688 iscsi_iser_scsi_transport = iscsi_register_transport(
689 &iscsi_iser_transport);
690 if (!iscsi_iser_scsi_transport) {
691 iser_err("iscsi_register_transport failed\n");
693 goto register_transport_failure;
698 register_transport_failure:
699 kmem_cache_destroy(ig.desc_cache);
704 static void __exit iser_exit(void)
706 iser_dbg("Removing iSER datamover...\n");
707 iscsi_unregister_transport(&iscsi_iser_transport);
708 kmem_cache_destroy(ig.desc_cache);
711 module_init(iser_init);
712 module_exit(iser_exit);