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 * Copyright (c) 2013-2014 Mellanox Technologies. All rights reserved.
9 * maintained by openib-general@openib.org
11 * This software is available to you under a choice of one of two
12 * licenses. You may choose to be licensed under the terms of the GNU
13 * General Public License (GPL) Version 2, available from the file
14 * COPYING in the main directory of this source tree, or the
15 * OpenIB.org BSD license below:
17 * Redistribution and use in source and binary forms, with or
18 * without modification, are permitted provided that the following
21 * - Redistributions of source code must retain the above
22 * copyright notice, this list of conditions and the following
25 * - Redistributions in binary form must reproduce the above
26 * copyright notice, this list of conditions and the following
27 * disclaimer in the documentation and/or other materials
28 * provided with the distribution.
30 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
31 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
32 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
33 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
34 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
35 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
36 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
48 #include <linux/types.h>
49 #include <linux/list.h>
50 #include <linux/hardirq.h>
51 #include <linux/kfifo.h>
52 #include <linux/blkdev.h>
53 #include <linux/init.h>
54 #include <linux/ioctl.h>
55 #include <linux/cdev.h>
57 #include <linux/net.h>
58 #include <linux/scatterlist.h>
59 #include <linux/delay.h>
60 #include <linux/slab.h>
61 #include <linux/module.h>
65 #include <linux/uaccess.h>
67 #include <scsi/scsi_cmnd.h>
68 #include <scsi/scsi_device.h>
69 #include <scsi/scsi_eh.h>
70 #include <scsi/scsi_tcq.h>
71 #include <scsi/scsi_host.h>
72 #include <scsi/scsi.h>
73 #include <scsi/scsi_transport_iscsi.h>
75 #include "iscsi_iser.h"
77 MODULE_DESCRIPTION("iSER (iSCSI Extensions for RDMA) Datamover");
78 MODULE_LICENSE("Dual BSD/GPL");
79 MODULE_AUTHOR("Alex Nezhinsky, Dan Bar Dov, Or Gerlitz");
81 static struct scsi_host_template iscsi_iser_sht
;
82 static struct iscsi_transport iscsi_iser_transport
;
83 static struct scsi_transport_template
*iscsi_iser_scsi_transport
;
84 static struct workqueue_struct
*release_wq
;
85 static DEFINE_MUTEX(unbind_iser_conn_mutex
);
86 struct iser_global ig
;
88 int iser_debug_level
= 0;
89 module_param_named(debug_level
, iser_debug_level
, int, S_IRUGO
| S_IWUSR
);
90 MODULE_PARM_DESC(debug_level
, "Enable debug tracing if > 0 (default:disabled)");
92 static unsigned int iscsi_max_lun
= 512;
93 module_param_named(max_lun
, iscsi_max_lun
, uint
, S_IRUGO
);
94 MODULE_PARM_DESC(max_lun
, "Max LUNs to allow per session (default:512");
96 unsigned int iser_max_sectors
= ISER_DEF_MAX_SECTORS
;
97 module_param_named(max_sectors
, iser_max_sectors
, uint
, S_IRUGO
| S_IWUSR
);
98 MODULE_PARM_DESC(max_sectors
, "Max number of sectors in a single scsi command (default:1024");
100 bool iser_always_reg
= true;
101 module_param_named(always_register
, iser_always_reg
, bool, S_IRUGO
);
102 MODULE_PARM_DESC(always_register
,
103 "Always register memory, even for continuous memory regions (default:true)");
105 bool iser_pi_enable
= false;
106 module_param_named(pi_enable
, iser_pi_enable
, bool, S_IRUGO
);
107 MODULE_PARM_DESC(pi_enable
, "Enable T10-PI offload support (default:disabled)");
110 module_param_named(pi_guard
, iser_pi_guard
, int, S_IRUGO
);
111 MODULE_PARM_DESC(pi_guard
, "T10-PI guard_type [deprecated]");
114 * iscsi_iser_recv() - Process a successful recv completion
115 * @conn: iscsi connection
117 * @rx_data: buffer containing receive data payload
118 * @rx_data_len: length of rx_data
120 * Notes: In case of data length errors or iscsi PDU completion failures
121 * this routine will signal iscsi layer of connection failure.
124 iscsi_iser_recv(struct iscsi_conn
*conn
, struct iscsi_hdr
*hdr
,
125 char *rx_data
, int rx_data_len
)
130 /* verify PDU length */
131 datalen
= ntoh24(hdr
->dlength
);
132 if (datalen
> rx_data_len
|| (datalen
+ 4) < rx_data_len
) {
133 iser_err("wrong datalen %d (hdr), %d (IB)\n",
134 datalen
, rx_data_len
);
135 rc
= ISCSI_ERR_DATALEN
;
139 if (datalen
!= rx_data_len
)
140 iser_dbg("aligned datalen (%d) hdr, %d (IB)\n",
141 datalen
, rx_data_len
);
143 rc
= iscsi_complete_pdu(conn
, hdr
, rx_data
, rx_data_len
);
144 if (rc
&& rc
!= ISCSI_ERR_NO_SCSI_CMD
)
149 iscsi_conn_failure(conn
, rc
);
153 * iscsi_iser_pdu_alloc() - allocate an iscsi-iser PDU
155 * @opcode: iscsi command opcode
157 * Netes: This routine can't fail, just assign iscsi task
158 * hdr and max hdr size.
161 iscsi_iser_pdu_alloc(struct iscsi_task
*task
, uint8_t opcode
)
163 struct iscsi_iser_task
*iser_task
= task
->dd_data
;
165 task
->hdr
= (struct iscsi_hdr
*)&iser_task
->desc
.iscsi_header
;
166 task
->hdr_max
= sizeof(iser_task
->desc
.iscsi_header
);
172 * iser_initialize_task_headers() - Initialize task headers
174 * @tx_desc: iser tx descriptor
177 * This routine may race with iser teardown flow for scsi
178 * error handling TMFs. So for TMF we should acquire the
179 * state mutex to avoid dereferencing the IB device which
180 * may have already been terminated.
183 iser_initialize_task_headers(struct iscsi_task
*task
,
184 struct iser_tx_desc
*tx_desc
)
186 struct iser_conn
*iser_conn
= task
->conn
->dd_data
;
187 struct iser_device
*device
= iser_conn
->ib_conn
.device
;
188 struct iscsi_iser_task
*iser_task
= task
->dd_data
;
191 if (unlikely(iser_conn
->state
!= ISER_CONN_UP
))
194 dma_addr
= ib_dma_map_single(device
->ib_device
, (void *)tx_desc
,
195 ISER_HEADERS_LEN
, DMA_TO_DEVICE
);
196 if (ib_dma_mapping_error(device
->ib_device
, dma_addr
))
199 tx_desc
->inv_wr
.next
= NULL
;
200 tx_desc
->reg_wr
.wr
.next
= NULL
;
201 tx_desc
->mapped
= true;
202 tx_desc
->dma_addr
= dma_addr
;
203 tx_desc
->tx_sg
[0].addr
= tx_desc
->dma_addr
;
204 tx_desc
->tx_sg
[0].length
= ISER_HEADERS_LEN
;
205 tx_desc
->tx_sg
[0].lkey
= device
->pd
->local_dma_lkey
;
207 iser_task
->iser_conn
= iser_conn
;
213 * iscsi_iser_task_init() - Initialize iscsi-iser task
216 * Initialize the task for the scsi command or mgmt command.
218 * Return: Returns zero on success or -ENOMEM when failing
219 * to init task headers (dma mapping error).
222 iscsi_iser_task_init(struct iscsi_task
*task
)
224 struct iscsi_iser_task
*iser_task
= task
->dd_data
;
227 ret
= iser_initialize_task_headers(task
, &iser_task
->desc
);
229 iser_err("Failed to init task %p, err = %d\n",
238 iser_task
->command_sent
= 0;
239 iser_task_rdma_init(iser_task
);
240 iser_task
->sc
= task
->sc
;
246 * iscsi_iser_mtask_xmit() - xmit management (immediate) task
247 * @conn: iscsi connection
248 * @task: task management task
251 * The function can return -EAGAIN in which case caller must
252 * call it again later, or recover. '0' return code means successful
257 iscsi_iser_mtask_xmit(struct iscsi_conn
*conn
, struct iscsi_task
*task
)
261 iser_dbg("mtask xmit [cid %d itt 0x%x]\n", conn
->id
, task
->itt
);
263 error
= iser_send_control(conn
, task
);
265 /* since iser xmits control with zero copy, tasks can not be recycled
266 * right after sending them.
267 * The recycling scheme is based on whether a response is expected
268 * - if yes, the task is recycled at iscsi_complete_pdu
269 * - if no, the task is recycled at iser_snd_completion
275 iscsi_iser_task_xmit_unsol_data(struct iscsi_conn
*conn
,
276 struct iscsi_task
*task
)
278 struct iscsi_r2t_info
*r2t
= &task
->unsol_r2t
;
279 struct iscsi_data hdr
;
282 /* Send data-out PDUs while there's still unsolicited data to send */
283 while (iscsi_task_has_unsol_data(task
)) {
284 iscsi_prep_data_out_pdu(task
, r2t
, &hdr
);
285 iser_dbg("Sending data-out: itt 0x%x, data count %d\n",
286 hdr
.itt
, r2t
->data_count
);
288 /* the buffer description has been passed with the command */
289 /* Send the command */
290 error
= iser_send_data_out(conn
, task
, &hdr
);
293 goto iscsi_iser_task_xmit_unsol_data_exit
;
295 r2t
->sent
+= r2t
->data_count
;
296 iser_dbg("Need to send %d more as data-out PDUs\n",
297 r2t
->data_length
- r2t
->sent
);
300 iscsi_iser_task_xmit_unsol_data_exit
:
305 * iscsi_iser_task_xmit() - xmit iscsi-iser task
308 * Return: zero on success or escalates $error on failure.
311 iscsi_iser_task_xmit(struct iscsi_task
*task
)
313 struct iscsi_conn
*conn
= task
->conn
;
314 struct iscsi_iser_task
*iser_task
= task
->dd_data
;
318 return iscsi_iser_mtask_xmit(conn
, task
);
320 if (task
->sc
->sc_data_direction
== DMA_TO_DEVICE
) {
321 BUG_ON(scsi_bufflen(task
->sc
) == 0);
323 iser_dbg("cmd [itt %x total %d imm %d unsol_data %d\n",
324 task
->itt
, scsi_bufflen(task
->sc
),
325 task
->imm_count
, task
->unsol_r2t
.data_length
);
328 iser_dbg("ctask xmit [cid %d itt 0x%x]\n",
329 conn
->id
, task
->itt
);
331 /* Send the cmd PDU */
332 if (!iser_task
->command_sent
) {
333 error
= iser_send_command(conn
, task
);
335 goto iscsi_iser_task_xmit_exit
;
336 iser_task
->command_sent
= 1;
339 /* Send unsolicited data-out PDU(s) if necessary */
340 if (iscsi_task_has_unsol_data(task
))
341 error
= iscsi_iser_task_xmit_unsol_data(conn
, task
);
343 iscsi_iser_task_xmit_exit
:
348 * iscsi_iser_cleanup_task() - cleanup an iscsi-iser task
351 * Notes: In case the RDMA device is already NULL (might have
352 * been removed in DEVICE_REMOVAL CM event it will bail-out
353 * without doing dma unmapping.
355 static void iscsi_iser_cleanup_task(struct iscsi_task
*task
)
357 struct iscsi_iser_task
*iser_task
= task
->dd_data
;
358 struct iser_tx_desc
*tx_desc
= &iser_task
->desc
;
359 struct iser_conn
*iser_conn
= task
->conn
->dd_data
;
360 struct iser_device
*device
= iser_conn
->ib_conn
.device
;
362 /* DEVICE_REMOVAL event might have already released the device */
366 if (likely(tx_desc
->mapped
)) {
367 ib_dma_unmap_single(device
->ib_device
, tx_desc
->dma_addr
,
368 ISER_HEADERS_LEN
, DMA_TO_DEVICE
);
369 tx_desc
->mapped
= false;
372 /* mgmt tasks do not need special cleanup */
376 if (iser_task
->status
== ISER_TASK_STATUS_STARTED
) {
377 iser_task
->status
= ISER_TASK_STATUS_COMPLETED
;
378 iser_task_rdma_finalize(iser_task
);
383 * iscsi_iser_check_protection() - check protection information status of task.
385 * @sector: error sector if exsists (output)
387 * Return: zero if no data-integrity errors have occured
388 * 0x1: data-integrity error occured in the guard-block
389 * 0x2: data-integrity error occured in the reference tag
390 * 0x3: data-integrity error occured in the application tag
392 * In addition the error sector is marked.
395 iscsi_iser_check_protection(struct iscsi_task
*task
, sector_t
*sector
)
397 struct iscsi_iser_task
*iser_task
= task
->dd_data
;
398 enum iser_data_dir dir
= iser_task
->dir
[ISER_DIR_IN
] ?
399 ISER_DIR_IN
: ISER_DIR_OUT
;
401 return iser_check_task_pi_status(iser_task
, dir
, sector
);
405 * iscsi_iser_conn_create() - create a new iscsi-iser connection
406 * @cls_session: iscsi class connection
407 * @conn_idx: connection index within the session (for MCS)
409 * Return: iscsi_cls_conn when iscsi_conn_setup succeeds or NULL
412 static struct iscsi_cls_conn
*
413 iscsi_iser_conn_create(struct iscsi_cls_session
*cls_session
,
416 struct iscsi_conn
*conn
;
417 struct iscsi_cls_conn
*cls_conn
;
419 cls_conn
= iscsi_conn_setup(cls_session
, 0, conn_idx
);
422 conn
= cls_conn
->dd_data
;
425 * due to issues with the login code re iser sematics
426 * this not set in iscsi_conn_setup - FIXME
428 conn
->max_recv_dlength
= ISER_RECV_DATA_SEG_LEN
;
434 * iscsi_iser_conn_bind() - bind iscsi and iser connection structures
435 * @cls_session: iscsi class session
436 * @cls_conn: iscsi class connection
437 * @transport_eph: transport end-point handle
438 * @is_leading: indicate if this is the session leading connection (MCS)
440 * Return: zero on success, $error if iscsi_conn_bind fails and
441 * -EINVAL in case end-point doesn't exsits anymore or iser connection
442 * state is not UP (teardown already started).
445 iscsi_iser_conn_bind(struct iscsi_cls_session
*cls_session
,
446 struct iscsi_cls_conn
*cls_conn
,
447 uint64_t transport_eph
,
450 struct iscsi_conn
*conn
= cls_conn
->dd_data
;
451 struct iser_conn
*iser_conn
;
452 struct iscsi_endpoint
*ep
;
455 error
= iscsi_conn_bind(cls_session
, cls_conn
, is_leading
);
459 /* the transport ep handle comes from user space so it must be
460 * verified against the global ib connections list */
461 ep
= iscsi_lookup_endpoint(transport_eph
);
463 iser_err("can't bind eph %llx\n",
464 (unsigned long long)transport_eph
);
467 iser_conn
= ep
->dd_data
;
469 mutex_lock(&iser_conn
->state_mutex
);
470 if (iser_conn
->state
!= ISER_CONN_UP
) {
472 iser_err("iser_conn %p state is %d, teardown started\n",
473 iser_conn
, iser_conn
->state
);
477 error
= iser_alloc_rx_descriptors(iser_conn
, conn
->session
);
481 /* binds the iSER connection retrieved from the previously
482 * connected ep_handle to the iSCSI layer connection. exchanges
483 * connection pointers */
484 iser_info("binding iscsi conn %p to iser_conn %p\n", conn
, iser_conn
);
486 conn
->dd_data
= iser_conn
;
487 iser_conn
->iscsi_conn
= conn
;
490 mutex_unlock(&iser_conn
->state_mutex
);
495 * iscsi_iser_conn_start() - start iscsi-iser connection
496 * @cls_conn: iscsi class connection
498 * Notes: Here iser intialize (or re-initialize) stop_completion as
499 * from this point iscsi must call conn_stop in session/connection
500 * teardown so iser transport must wait for it.
503 iscsi_iser_conn_start(struct iscsi_cls_conn
*cls_conn
)
505 struct iscsi_conn
*iscsi_conn
;
506 struct iser_conn
*iser_conn
;
508 iscsi_conn
= cls_conn
->dd_data
;
509 iser_conn
= iscsi_conn
->dd_data
;
510 reinit_completion(&iser_conn
->stop_completion
);
512 return iscsi_conn_start(cls_conn
);
516 * iscsi_iser_conn_stop() - stop iscsi-iser connection
517 * @cls_conn: iscsi class connection
518 * @flag: indicate if recover or terminate (passed as is)
520 * Notes: Calling iscsi_conn_stop might theoretically race with
521 * DEVICE_REMOVAL event and dereference a previously freed RDMA device
522 * handle, so we call it under iser the state lock to protect against
526 iscsi_iser_conn_stop(struct iscsi_cls_conn
*cls_conn
, int flag
)
528 struct iscsi_conn
*conn
= cls_conn
->dd_data
;
529 struct iser_conn
*iser_conn
= conn
->dd_data
;
531 iser_info("stopping iscsi_conn: %p, iser_conn: %p\n", conn
, iser_conn
);
534 * Userspace may have goofed up and not bound the connection or
535 * might have only partially setup the connection.
538 mutex_lock(&iser_conn
->state_mutex
);
539 mutex_lock(&unbind_iser_conn_mutex
);
540 iser_conn_terminate(iser_conn
);
541 iscsi_conn_stop(cls_conn
, flag
);
544 iser_conn
->iscsi_conn
= NULL
;
545 conn
->dd_data
= NULL
;
546 mutex_unlock(&unbind_iser_conn_mutex
);
548 complete(&iser_conn
->stop_completion
);
549 mutex_unlock(&iser_conn
->state_mutex
);
551 iscsi_conn_stop(cls_conn
, flag
);
556 * iscsi_iser_session_destroy() - destroy iscsi-iser session
557 * @cls_session: iscsi class session
559 * Removes and free iscsi host.
562 iscsi_iser_session_destroy(struct iscsi_cls_session
*cls_session
)
564 struct Scsi_Host
*shost
= iscsi_session_to_shost(cls_session
);
566 iscsi_session_teardown(cls_session
);
567 iscsi_host_remove(shost
);
568 iscsi_host_free(shost
);
571 static inline unsigned int
572 iser_dif_prot_caps(int prot_caps
)
574 return ((prot_caps
& IB_PROT_T10DIF_TYPE_1
) ?
575 SHOST_DIF_TYPE1_PROTECTION
| SHOST_DIX_TYPE0_PROTECTION
|
576 SHOST_DIX_TYPE1_PROTECTION
: 0) |
577 ((prot_caps
& IB_PROT_T10DIF_TYPE_2
) ?
578 SHOST_DIF_TYPE2_PROTECTION
| SHOST_DIX_TYPE2_PROTECTION
: 0) |
579 ((prot_caps
& IB_PROT_T10DIF_TYPE_3
) ?
580 SHOST_DIF_TYPE3_PROTECTION
| SHOST_DIX_TYPE3_PROTECTION
: 0);
584 * iscsi_iser_session_create() - create an iscsi-iser session
585 * @ep: iscsi end-point handle
586 * @cmds_max: maximum commands in this session
587 * @qdepth: session command queue depth
588 * @initial_cmdsn: initiator command sequnce number
590 * Allocates and adds a scsi host, expose DIF supprot if
591 * exists, and sets up an iscsi session.
593 static struct iscsi_cls_session
*
594 iscsi_iser_session_create(struct iscsi_endpoint
*ep
,
595 uint16_t cmds_max
, uint16_t qdepth
,
596 uint32_t initial_cmdsn
)
598 struct iscsi_cls_session
*cls_session
;
599 struct Scsi_Host
*shost
;
600 struct iser_conn
*iser_conn
= NULL
;
601 struct ib_conn
*ib_conn
;
602 struct ib_device
*ib_dev
;
605 shost
= iscsi_host_alloc(&iscsi_iser_sht
, 0, 0);
608 shost
->transportt
= iscsi_iser_scsi_transport
;
609 shost
->cmd_per_lun
= qdepth
;
610 shost
->max_lun
= iscsi_max_lun
;
612 shost
->max_channel
= 0;
613 shost
->max_cmd_len
= 16;
616 * older userspace tools (before 2.0-870) did not pass us
617 * the leading conn's ep so this will be NULL;
620 iser_conn
= ep
->dd_data
;
621 shost
->sg_tablesize
= iser_conn
->scsi_sg_tablesize
;
622 shost
->can_queue
= min_t(u16
, cmds_max
, iser_conn
->max_cmds
);
624 mutex_lock(&iser_conn
->state_mutex
);
625 if (iser_conn
->state
!= ISER_CONN_UP
) {
626 iser_err("iser conn %p already started teardown\n",
628 mutex_unlock(&iser_conn
->state_mutex
);
632 ib_conn
= &iser_conn
->ib_conn
;
633 ib_dev
= ib_conn
->device
->ib_device
;
634 if (ib_conn
->pi_support
) {
635 u32 sig_caps
= ib_dev
->attrs
.sig_prot_cap
;
637 shost
->sg_prot_tablesize
= shost
->sg_tablesize
;
638 scsi_host_set_prot(shost
, iser_dif_prot_caps(sig_caps
));
639 scsi_host_set_guard(shost
, SHOST_DIX_GUARD_IP
|
640 SHOST_DIX_GUARD_CRC
);
643 if (!(ib_dev
->attrs
.device_cap_flags
& IB_DEVICE_SG_GAPS_REG
))
644 shost
->virt_boundary_mask
= SZ_4K
- 1;
646 if (iscsi_host_add(shost
, ib_dev
->dev
.parent
)) {
647 mutex_unlock(&iser_conn
->state_mutex
);
650 mutex_unlock(&iser_conn
->state_mutex
);
652 shost
->can_queue
= min_t(u16
, cmds_max
, ISER_DEF_XMIT_CMDS_MAX
);
653 if (iscsi_host_add(shost
, NULL
))
657 max_fr_sectors
= (shost
->sg_tablesize
* PAGE_SIZE
) >> 9;
658 shost
->max_sectors
= min(iser_max_sectors
, max_fr_sectors
);
660 iser_dbg("iser_conn %p, sg_tablesize %u, max_sectors %u\n",
661 iser_conn
, shost
->sg_tablesize
,
664 if (shost
->max_sectors
< iser_max_sectors
)
665 iser_warn("max_sectors was reduced from %u to %u\n",
666 iser_max_sectors
, shost
->max_sectors
);
668 cls_session
= iscsi_session_setup(&iscsi_iser_transport
, shost
,
670 sizeof(struct iscsi_iser_task
),
678 iscsi_host_remove(shost
);
680 iscsi_host_free(shost
);
685 iscsi_iser_set_param(struct iscsi_cls_conn
*cls_conn
,
686 enum iscsi_param param
, char *buf
, int buflen
)
691 case ISCSI_PARAM_MAX_RECV_DLENGTH
:
694 case ISCSI_PARAM_HDRDGST_EN
:
695 sscanf(buf
, "%d", &value
);
697 iser_err("DataDigest wasn't negotiated to None\n");
701 case ISCSI_PARAM_DATADGST_EN
:
702 sscanf(buf
, "%d", &value
);
704 iser_err("DataDigest wasn't negotiated to None\n");
708 case ISCSI_PARAM_IFMARKER_EN
:
709 sscanf(buf
, "%d", &value
);
711 iser_err("IFMarker wasn't negotiated to No\n");
715 case ISCSI_PARAM_OFMARKER_EN
:
716 sscanf(buf
, "%d", &value
);
718 iser_err("OFMarker wasn't negotiated to No\n");
723 return iscsi_set_param(cls_conn
, param
, buf
, buflen
);
730 * iscsi_iser_conn_get_stats() - get iscsi connection statistics
731 * @cls_conn: iscsi class connection
732 * @stats: iscsi stats to output
734 * Output connection statistics.
737 iscsi_iser_conn_get_stats(struct iscsi_cls_conn
*cls_conn
, struct iscsi_stats
*stats
)
739 struct iscsi_conn
*conn
= cls_conn
->dd_data
;
741 stats
->txdata_octets
= conn
->txdata_octets
;
742 stats
->rxdata_octets
= conn
->rxdata_octets
;
743 stats
->scsicmd_pdus
= conn
->scsicmd_pdus_cnt
;
744 stats
->dataout_pdus
= conn
->dataout_pdus_cnt
;
745 stats
->scsirsp_pdus
= conn
->scsirsp_pdus_cnt
;
746 stats
->datain_pdus
= conn
->datain_pdus_cnt
; /* always 0 */
747 stats
->r2t_pdus
= conn
->r2t_pdus_cnt
; /* always 0 */
748 stats
->tmfcmd_pdus
= conn
->tmfcmd_pdus_cnt
;
749 stats
->tmfrsp_pdus
= conn
->tmfrsp_pdus_cnt
;
750 stats
->custom_length
= 0;
753 static int iscsi_iser_get_ep_param(struct iscsi_endpoint
*ep
,
754 enum iscsi_param param
, char *buf
)
756 struct iser_conn
*iser_conn
= ep
->dd_data
;
759 case ISCSI_PARAM_CONN_PORT
:
760 case ISCSI_PARAM_CONN_ADDRESS
:
761 if (!iser_conn
|| !iser_conn
->ib_conn
.cma_id
)
764 return iscsi_conn_get_addr_param((struct sockaddr_storage
*)
765 &iser_conn
->ib_conn
.cma_id
->route
.addr
.dst_addr
,
774 * iscsi_iser_ep_connect() - Initiate iSER connection establishment
776 * @dst_addr: destination address
777 * @non_blocking: indicate if routine can block
779 * Allocate an iscsi endpoint, an iser_conn structure and bind them.
780 * After that start RDMA connection establishment via rdma_cm. We
781 * don't allocate iser_conn embedded in iscsi_endpoint since in teardown
782 * the endpoint will be destroyed at ep_disconnect while iser_conn will
783 * cleanup its resources asynchronuously.
785 * Return: iscsi_endpoint created by iscsi layer or ERR_PTR(error)
788 static struct iscsi_endpoint
*
789 iscsi_iser_ep_connect(struct Scsi_Host
*shost
, struct sockaddr
*dst_addr
,
793 struct iser_conn
*iser_conn
;
794 struct iscsi_endpoint
*ep
;
796 ep
= iscsi_create_endpoint(0);
798 return ERR_PTR(-ENOMEM
);
800 iser_conn
= kzalloc(sizeof(*iser_conn
), GFP_KERNEL
);
806 ep
->dd_data
= iser_conn
;
808 iser_conn_init(iser_conn
);
810 err
= iser_connect(iser_conn
, NULL
, dst_addr
, non_blocking
);
816 iscsi_destroy_endpoint(ep
);
821 * iscsi_iser_ep_poll() - poll for iser connection establishment to complete
822 * @ep: iscsi endpoint (created at ep_connect)
823 * @timeout_ms: polling timeout allowed in ms.
825 * This routine boils down to waiting for up_completion signaling
826 * that cma_id got CONNECTED event.
828 * Return: 1 if succeeded in connection establishment, 0 if timeout expired
829 * (libiscsi will retry will kick in) or -1 if interrupted by signal
830 * or more likely iser connection state transitioned to TEMINATING or
831 * DOWN during the wait period.
834 iscsi_iser_ep_poll(struct iscsi_endpoint
*ep
, int timeout_ms
)
836 struct iser_conn
*iser_conn
= ep
->dd_data
;
839 rc
= wait_for_completion_interruptible_timeout(&iser_conn
->up_completion
,
840 msecs_to_jiffies(timeout_ms
));
841 /* if conn establishment failed, return error code to iscsi */
843 mutex_lock(&iser_conn
->state_mutex
);
844 if (iser_conn
->state
== ISER_CONN_TERMINATING
||
845 iser_conn
->state
== ISER_CONN_DOWN
)
847 mutex_unlock(&iser_conn
->state_mutex
);
850 iser_info("iser conn %p rc = %d\n", iser_conn
, rc
);
853 return 1; /* success, this is the equivalent of EPOLLOUT */
855 return 0; /* timeout */
857 return rc
; /* signal */
861 * iscsi_iser_ep_disconnect() - Initiate connection teardown process
862 * @ep: iscsi endpoint handle
864 * This routine is not blocked by iser and RDMA termination process
865 * completion as we queue a deffered work for iser/RDMA destruction
866 * and cleanup or actually call it immediately in case we didn't pass
867 * iscsi conn bind/start stage, thus it is safe.
870 iscsi_iser_ep_disconnect(struct iscsi_endpoint
*ep
)
872 struct iser_conn
*iser_conn
= ep
->dd_data
;
874 iser_info("ep %p iser conn %p\n", ep
, iser_conn
);
876 mutex_lock(&iser_conn
->state_mutex
);
877 iser_conn_terminate(iser_conn
);
880 * if iser_conn and iscsi_conn are bound, we must wait for
881 * iscsi_conn_stop and flush errors completion before freeing
882 * the iser resources. Otherwise we are safe to free resources
885 if (iser_conn
->iscsi_conn
) {
886 INIT_WORK(&iser_conn
->release_work
, iser_release_work
);
887 queue_work(release_wq
, &iser_conn
->release_work
);
888 mutex_unlock(&iser_conn
->state_mutex
);
890 iser_conn
->state
= ISER_CONN_DOWN
;
891 mutex_unlock(&iser_conn
->state_mutex
);
892 iser_conn_release(iser_conn
);
895 iscsi_destroy_endpoint(ep
);
898 static umode_t
iser_attr_is_visible(int param_type
, int param
)
900 switch (param_type
) {
901 case ISCSI_HOST_PARAM
:
903 case ISCSI_HOST_PARAM_NETDEV_NAME
:
904 case ISCSI_HOST_PARAM_HWADDRESS
:
905 case ISCSI_HOST_PARAM_INITIATOR_NAME
:
912 case ISCSI_PARAM_MAX_RECV_DLENGTH
:
913 case ISCSI_PARAM_MAX_XMIT_DLENGTH
:
914 case ISCSI_PARAM_HDRDGST_EN
:
915 case ISCSI_PARAM_DATADGST_EN
:
916 case ISCSI_PARAM_CONN_ADDRESS
:
917 case ISCSI_PARAM_CONN_PORT
:
918 case ISCSI_PARAM_EXP_STATSN
:
919 case ISCSI_PARAM_PERSISTENT_ADDRESS
:
920 case ISCSI_PARAM_PERSISTENT_PORT
:
921 case ISCSI_PARAM_PING_TMO
:
922 case ISCSI_PARAM_RECV_TMO
:
923 case ISCSI_PARAM_INITIAL_R2T_EN
:
924 case ISCSI_PARAM_MAX_R2T
:
925 case ISCSI_PARAM_IMM_DATA_EN
:
926 case ISCSI_PARAM_FIRST_BURST
:
927 case ISCSI_PARAM_MAX_BURST
:
928 case ISCSI_PARAM_PDU_INORDER_EN
:
929 case ISCSI_PARAM_DATASEQ_INORDER_EN
:
930 case ISCSI_PARAM_TARGET_NAME
:
931 case ISCSI_PARAM_TPGT
:
932 case ISCSI_PARAM_USERNAME
:
933 case ISCSI_PARAM_PASSWORD
:
934 case ISCSI_PARAM_USERNAME_IN
:
935 case ISCSI_PARAM_PASSWORD_IN
:
936 case ISCSI_PARAM_FAST_ABORT
:
937 case ISCSI_PARAM_ABORT_TMO
:
938 case ISCSI_PARAM_LU_RESET_TMO
:
939 case ISCSI_PARAM_TGT_RESET_TMO
:
940 case ISCSI_PARAM_IFACE_NAME
:
941 case ISCSI_PARAM_INITIATOR_NAME
:
942 case ISCSI_PARAM_DISCOVERY_SESS
:
952 static struct scsi_host_template iscsi_iser_sht
= {
953 .module
= THIS_MODULE
,
954 .name
= "iSCSI Initiator over iSER",
955 .queuecommand
= iscsi_queuecommand
,
956 .change_queue_depth
= scsi_change_queue_depth
,
957 .sg_tablesize
= ISCSI_ISER_DEF_SG_TABLESIZE
,
958 .cmd_per_lun
= ISER_DEF_CMD_PER_LUN
,
959 .eh_timed_out
= iscsi_eh_cmd_timed_out
,
960 .eh_abort_handler
= iscsi_eh_abort
,
961 .eh_device_reset_handler
= iscsi_eh_device_reset
,
962 .eh_target_reset_handler
= iscsi_eh_recover_target
,
963 .target_alloc
= iscsi_target_alloc
,
964 .proc_name
= "iscsi_iser",
966 .track_queue_depth
= 1,
969 static struct iscsi_transport iscsi_iser_transport
= {
970 .owner
= THIS_MODULE
,
972 .caps
= CAP_RECOVERY_L0
| CAP_MULTI_R2T
| CAP_TEXT_NEGO
,
973 /* session management */
974 .create_session
= iscsi_iser_session_create
,
975 .destroy_session
= iscsi_iser_session_destroy
,
976 /* connection management */
977 .create_conn
= iscsi_iser_conn_create
,
978 .bind_conn
= iscsi_iser_conn_bind
,
979 .destroy_conn
= iscsi_conn_teardown
,
980 .attr_is_visible
= iser_attr_is_visible
,
981 .set_param
= iscsi_iser_set_param
,
982 .get_conn_param
= iscsi_conn_get_param
,
983 .get_ep_param
= iscsi_iser_get_ep_param
,
984 .get_session_param
= iscsi_session_get_param
,
985 .start_conn
= iscsi_iser_conn_start
,
986 .stop_conn
= iscsi_iser_conn_stop
,
987 /* iscsi host params */
988 .get_host_param
= iscsi_host_get_param
,
989 .set_host_param
= iscsi_host_set_param
,
991 .send_pdu
= iscsi_conn_send_pdu
,
992 .get_stats
= iscsi_iser_conn_get_stats
,
993 .init_task
= iscsi_iser_task_init
,
994 .xmit_task
= iscsi_iser_task_xmit
,
995 .cleanup_task
= iscsi_iser_cleanup_task
,
996 .alloc_pdu
= iscsi_iser_pdu_alloc
,
997 .check_protection
= iscsi_iser_check_protection
,
999 .session_recovery_timedout
= iscsi_session_recovery_timedout
,
1001 .ep_connect
= iscsi_iser_ep_connect
,
1002 .ep_poll
= iscsi_iser_ep_poll
,
1003 .ep_disconnect
= iscsi_iser_ep_disconnect
1006 static int __init
iser_init(void)
1010 iser_dbg("Starting iSER datamover...\n");
1012 if (iscsi_max_lun
< 1) {
1013 iser_err("Invalid max_lun value of %u\n", iscsi_max_lun
);
1017 memset(&ig
, 0, sizeof(struct iser_global
));
1019 ig
.desc_cache
= kmem_cache_create("iser_descriptors",
1020 sizeof(struct iser_tx_desc
),
1021 0, SLAB_HWCACHE_ALIGN
,
1023 if (ig
.desc_cache
== NULL
)
1026 /* device init is called only after the first addr resolution */
1027 mutex_init(&ig
.device_list_mutex
);
1028 INIT_LIST_HEAD(&ig
.device_list
);
1029 mutex_init(&ig
.connlist_mutex
);
1030 INIT_LIST_HEAD(&ig
.connlist
);
1032 release_wq
= alloc_workqueue("release workqueue", 0, 0);
1034 iser_err("failed to allocate release workqueue\n");
1039 iscsi_iser_scsi_transport
= iscsi_register_transport(
1040 &iscsi_iser_transport
);
1041 if (!iscsi_iser_scsi_transport
) {
1042 iser_err("iscsi_register_transport failed\n");
1050 destroy_workqueue(release_wq
);
1052 kmem_cache_destroy(ig
.desc_cache
);
1057 static void __exit
iser_exit(void)
1059 struct iser_conn
*iser_conn
, *n
;
1062 iser_dbg("Removing iSER datamover...\n");
1063 destroy_workqueue(release_wq
);
1065 mutex_lock(&ig
.connlist_mutex
);
1066 connlist_empty
= list_empty(&ig
.connlist
);
1067 mutex_unlock(&ig
.connlist_mutex
);
1069 if (!connlist_empty
) {
1070 iser_err("Error cleanup stage completed but we still have iser "
1071 "connections, destroying them anyway\n");
1072 list_for_each_entry_safe(iser_conn
, n
, &ig
.connlist
,
1074 iser_conn_release(iser_conn
);
1078 iscsi_unregister_transport(&iscsi_iser_transport
);
1079 kmem_cache_destroy(ig
.desc_cache
);
1082 module_init(iser_init
);
1083 module_exit(iser_exit
);