xref: /freebsd/share/man/man4/iser.4 (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1.\" Copyright (c) 2015, Mellanox Technologies, Inc. All rights reserved.
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
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.
11.\"
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
22.\" SUCH DAMAGE.
23.\"
24.\"
25.\" $FreeBSD$
26.Dd June 6, 2016
27.Dt ISER 4
28.Os
29.Sh NAME
30.Nm iser
31.Nd iSCSI Extensions for RDMA (iSER) driver
32.Sh SYNOPSIS
33To compile this driver into the kernel,
34place the following line in the
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device iser"
38.Ed
39.Pp
40Alternatively, to load the driver as a
41module at boot time, place the following line in
42.Xr loader.conf 5 :
43.Bd -literal -offset indent
44iser_load="YES"
45.Ed
46.Sh DESCRIPTION
47The
48.Nm
49(iSCSI Extensions for RDMA) initiator driver extends the iSCSI protocol to RDMA.
50It permits data to be transferred directly into and out of SCSI buffers
51without intermediate data copies.
52iSER uses the RDMA protocol suite to supply higher bandwidth for
53block storage transfers (zero copy behavior).
54To that fact, it eliminates the
55TCP/IP processing overhead while preserving the compatibility with iSCSI protocol.
56The initiator is the iSCSI/iSER client, which connects to an iSCSI/iSER target,
57providing local access to a remote block device.
58The userland component is provided by
59.Xr iscsid 8
60and both the kernel and userland are configured using
61.Xr iscsictl 8 .
62.Sh SYSCTL VARIABLES
63The following variables are available as both
64.Xr sysctl 8
65variables and
66.Xr loader 8
67tunables:
68.Bl -tag -width indent
69.It Va kern.iser.debug
70Verbosity level for log messages from the
71.Nm
72driver.
73Set to 0 to disable logging or 1 to warn about potential problems.
74Larger values enable info and debugging output.
75Defaults to 0.
76.El
77.Sh SEE ALSO
78.Xr iscsi 4 ,
79.Xr iscsi.conf 5 ,
80.Xr iscsictl 8 ,
81.Xr iscsid 8
82.Sh HISTORY
83The
84.Nm
85subsystem first appeared in
86.Fx 11.0 .
87.Sh AUTHORS
88The
89.Nm
90subsystem was developed by
91.An Max Gurtovoy Aq Mt maxg@mellanox.com
92and
93.An Sagi Grimberg Aq Mt sagig@mellanox.com
94under sponsorship from Mellanox Technologies.
95