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