xref: /freebsd/share/man/man4/iser.4 (revision 1072c68c851c82533fd6ec3581a9d3fcc2fbda71)
1*1072c68cSEdward Tomasz Napierala.\" Copyright (c) 2015, Mellanox Technologies, Inc. All rights reserved.
2*1072c68cSEdward Tomasz Napierala.\"
3*1072c68cSEdward Tomasz Napierala.\" Redistribution and use in source and binary forms, with or without
4*1072c68cSEdward Tomasz Napierala.\" modification, are permitted provided that the following conditions
5*1072c68cSEdward Tomasz Napierala.\" are met:
6*1072c68cSEdward Tomasz Napierala.\" 1. Redistributions of source code must retain the above copyright
7*1072c68cSEdward Tomasz Napierala.\"    notice, this list of conditions and the following disclaimer.
8*1072c68cSEdward Tomasz Napierala.\" 2. Redistributions in binary form must reproduce the above copyright
9*1072c68cSEdward Tomasz Napierala.\"    notice, this list of conditions and the following disclaimer in the
10*1072c68cSEdward Tomasz Napierala.\"    documentation and/or other materials provided with the distribution.
11*1072c68cSEdward Tomasz Napierala.\"
12*1072c68cSEdward Tomasz Napierala.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13*1072c68cSEdward Tomasz Napierala.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14*1072c68cSEdward Tomasz Napierala.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15*1072c68cSEdward Tomasz Napierala.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16*1072c68cSEdward Tomasz Napierala.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17*1072c68cSEdward Tomasz Napierala.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18*1072c68cSEdward Tomasz Napierala.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19*1072c68cSEdward Tomasz Napierala.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20*1072c68cSEdward Tomasz Napierala.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21*1072c68cSEdward Tomasz Napierala.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22*1072c68cSEdward Tomasz Napierala.\" SUCH DAMAGE.
23*1072c68cSEdward Tomasz Napierala.\"
24*1072c68cSEdward Tomasz Napierala.\"
25*1072c68cSEdward Tomasz Napierala.\" $FreeBSD$
26*1072c68cSEdward Tomasz Napierala.Dd June 6, 2016
27*1072c68cSEdward Tomasz Napierala.Dt ISER 4
28*1072c68cSEdward Tomasz Napierala.Os
29*1072c68cSEdward Tomasz Napierala.Sh NAME
30*1072c68cSEdward Tomasz Napierala.Nm iser
31*1072c68cSEdward Tomasz Napierala.Nd iSCSI Extensions for RDMA driver
32*1072c68cSEdward Tomasz Napierala.Sh SYNOPSIS
33*1072c68cSEdward Tomasz NapieralaTo compile this driver into the kernel,
34*1072c68cSEdward Tomasz Napieralaplace the following line in the
35*1072c68cSEdward Tomasz Napieralakernel configuration file:
36*1072c68cSEdward Tomasz Napierala.Bd -ragged -offset indent
37*1072c68cSEdward Tomasz Napierala.Cd "device iser"
38*1072c68cSEdward Tomasz Napierala.Ed
39*1072c68cSEdward Tomasz Napierala.Pp
40*1072c68cSEdward Tomasz NapieralaAlternatively, to load the driver as a
41*1072c68cSEdward Tomasz Napieralamodule at boot time, place the following line in
42*1072c68cSEdward Tomasz Napierala.Xr loader.conf 5 :
43*1072c68cSEdward Tomasz Napierala.Bd -literal -offset indent
44*1072c68cSEdward Tomasz Napieralaiser_load="YES"
45*1072c68cSEdward Tomasz Napierala.Ed
46*1072c68cSEdward Tomasz Napierala.Sh DESCRIPTION
47*1072c68cSEdward Tomasz NapieralaThe
48*1072c68cSEdward Tomasz Napierala.Nm
49*1072c68cSEdward Tomasz Napierala(iSCSI Extensions for RDMA) initiator driver extends the iSCSI protocol to RDMA.
50*1072c68cSEdward Tomasz NapieralaIt permits data to be transferred directly into and out of SCSI buffers
51*1072c68cSEdward Tomasz Napieralawithout intermediate data copies.
52*1072c68cSEdward Tomasz NapieralaiSER uses the RDMA protocol suite to supply higher bandwidth for
53*1072c68cSEdward Tomasz Napieralablock storage transfers (zero copy behavior). To that fact, it eliminates the
54*1072c68cSEdward Tomasz NapieralaTCP/IP processing overhead while preserving the compatibility with iSCSI protocol.
55*1072c68cSEdward Tomasz NapieralaThe initiator is the iSCSI/iSER client, which connects to an iSCSI/iSER target,
56*1072c68cSEdward Tomasz Napieralaproviding local access to a remote block device.
57*1072c68cSEdward Tomasz NapieralaThe userland component is provided by
58*1072c68cSEdward Tomasz Napierala.Xr iscsid 8
59*1072c68cSEdward Tomasz Napieralaand both the kernel and userland are configured using
60*1072c68cSEdward Tomasz Napierala.Xr iscsictl 8 .
61*1072c68cSEdward Tomasz Napierala.Sh SYSCTL VARIABLES
62*1072c68cSEdward Tomasz NapieralaThe following variables are available as both
63*1072c68cSEdward Tomasz Napierala.Xr sysctl 8
64*1072c68cSEdward Tomasz Napieralavariables and
65*1072c68cSEdward Tomasz Napierala.Xr loader 8
66*1072c68cSEdward Tomasz Napieralatunables:
67*1072c68cSEdward Tomasz Napierala.Bl -tag -width indent
68*1072c68cSEdward Tomasz Napierala.It Va kern.iser.debug
69*1072c68cSEdward Tomasz NapieralaVerbosity level for log messages from the
70*1072c68cSEdward Tomasz Napierala.Nm
71*1072c68cSEdward Tomasz Napieraladriver.
72*1072c68cSEdward Tomasz NapieralaSet to 0 to disable logging or 1 to warn about potential problems.
73*1072c68cSEdward Tomasz NapieralaLarger values enable info and debugging output.
74*1072c68cSEdward Tomasz NapieralaDefaults to 0.
75*1072c68cSEdward Tomasz Napierala.El
76*1072c68cSEdward Tomasz Napierala.Sh SEE ALSO
77*1072c68cSEdward Tomasz Napierala.Xr iscsi 4 ,
78*1072c68cSEdward Tomasz Napierala.Xr iscsi.conf 5 ,
79*1072c68cSEdward Tomasz Napierala.Xr iscsictl 8 ,
80*1072c68cSEdward Tomasz Napierala.Xr iscsid 8
81*1072c68cSEdward Tomasz Napierala.Sh HISTORY
82*1072c68cSEdward Tomasz NapieralaThe
83*1072c68cSEdward Tomasz Napierala.Nm
84*1072c68cSEdward Tomasz Napieralasubsystem first appeared in
85*1072c68cSEdward Tomasz Napierala.Fx 11.0 .
86*1072c68cSEdward Tomasz Napierala.Sh AUTHORS
87*1072c68cSEdward Tomasz NapieralaThe
88*1072c68cSEdward Tomasz Napierala.Nm
89*1072c68cSEdward Tomasz Napieralasubsystem was developed by
90*1072c68cSEdward Tomasz Napierala.An Max Gurtovoy Aq Mt maxg@mellanox.com
91*1072c68cSEdward Tomasz Napieralaand
92*1072c68cSEdward Tomasz Napierala.An Sagi Grimberg Aq Mt sagig@mellanox.com
93*1072c68cSEdward Tomasz Napieralaunder sponsorship from Mellanox Technologies.
94