1 .\" Copyright (c) 2015, Mellanox Technologies, Inc. All rights reserved.
3 .\" Redistribution and use in source and binary forms, with or without
4 .\" modification, are permitted provided that the following conditions
6 .\" 1. Redistributions of source code must retain the above copyright
7 .\" notice, this list of conditions and the following disclaimer.
8 .\" 2. Redistributions in binary form must reproduce the above copyright
9 .\" notice, this list of conditions and the following disclaimer in the
10 .\" documentation and/or other materials provided with the distribution.
12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .Nd iSCSI Extensions for RDMA (iSER) driver
31 To compile this driver into the kernel,
32 place the following line in the
33 kernel configuration file:
34 .Bd -ragged -offset indent
38 Alternatively, to load the driver as a
39 module at boot time, place the following line in
41 .Bd -literal -offset indent
47 (iSCSI Extensions for RDMA) initiator driver extends the iSCSI protocol to RDMA.
48 It permits data to be transferred directly into and out of SCSI buffers
49 without intermediate data copies.
50 iSER uses the RDMA protocol suite to supply higher bandwidth for
51 block storage transfers (zero copy behavior).
52 To that fact, it eliminates the
53 TCP/IP processing overhead while preserving the compatibility with iSCSI protocol.
54 The initiator is the iSCSI/iSER client, which connects to an iSCSI/iSER target,
55 providing local access to a remote block device.
56 The userland component is provided by
58 and both the kernel and userland are configured using
61 The following variables are available as both
66 .Bl -tag -width indent
67 .It Va kern.iser.debug
68 Verbosity level for log messages from the
71 Set to 0 to disable logging or 1 to warn about potential problems.
72 Larger values enable info and debugging output.
83 subsystem first appeared in
88 subsystem was developed by
89 .An Max Gurtovoy Aq Mt maxg@mellanox.com
91 .An Sagi Grimberg Aq Mt sagig@mellanox.com
92 under sponsorship from Mellanox Technologies.