xref: /freebsd/share/man/man4/iser.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
11072c68cSEdward Tomasz Napierala.\" Copyright (c) 2015, Mellanox Technologies, Inc. All rights reserved.
21072c68cSEdward Tomasz Napierala.\"
31072c68cSEdward Tomasz Napierala.\" Redistribution and use in source and binary forms, with or without
41072c68cSEdward Tomasz Napierala.\" modification, are permitted provided that the following conditions
51072c68cSEdward Tomasz Napierala.\" are met:
61072c68cSEdward Tomasz Napierala.\" 1. Redistributions of source code must retain the above copyright
71072c68cSEdward Tomasz Napierala.\"    notice, this list of conditions and the following disclaimer.
81072c68cSEdward Tomasz Napierala.\" 2. Redistributions in binary form must reproduce the above copyright
91072c68cSEdward Tomasz Napierala.\"    notice, this list of conditions and the following disclaimer in the
101072c68cSEdward Tomasz Napierala.\"    documentation and/or other materials provided with the distribution.
111072c68cSEdward Tomasz Napierala.\"
121072c68cSEdward Tomasz Napierala.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
131072c68cSEdward Tomasz Napierala.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
141072c68cSEdward Tomasz Napierala.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
151072c68cSEdward Tomasz Napierala.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
161072c68cSEdward Tomasz Napierala.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
171072c68cSEdward Tomasz Napierala.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
181072c68cSEdward Tomasz Napierala.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
191072c68cSEdward Tomasz Napierala.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
201072c68cSEdward Tomasz Napierala.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
211072c68cSEdward Tomasz Napierala.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
221072c68cSEdward Tomasz Napierala.\" SUCH DAMAGE.
231072c68cSEdward Tomasz Napierala.\"
241072c68cSEdward Tomasz Napierala.Dd June 6, 2016
251072c68cSEdward Tomasz Napierala.Dt ISER 4
261072c68cSEdward Tomasz Napierala.Os
271072c68cSEdward Tomasz Napierala.Sh NAME
281072c68cSEdward Tomasz Napierala.Nm iser
29*8cf995b3SEdward Tomasz Napierala.Nd iSCSI Extensions for RDMA (iSER) driver
301072c68cSEdward Tomasz Napierala.Sh SYNOPSIS
311072c68cSEdward Tomasz NapieralaTo compile this driver into the kernel,
321072c68cSEdward Tomasz Napieralaplace the following line in the
331072c68cSEdward Tomasz Napieralakernel configuration file:
341072c68cSEdward Tomasz Napierala.Bd -ragged -offset indent
351072c68cSEdward Tomasz Napierala.Cd "device iser"
361072c68cSEdward Tomasz Napierala.Ed
371072c68cSEdward Tomasz Napierala.Pp
381072c68cSEdward Tomasz NapieralaAlternatively, to load the driver as a
391072c68cSEdward Tomasz Napieralamodule at boot time, place the following line in
401072c68cSEdward Tomasz Napierala.Xr loader.conf 5 :
411072c68cSEdward Tomasz Napierala.Bd -literal -offset indent
421072c68cSEdward Tomasz Napieralaiser_load="YES"
431072c68cSEdward Tomasz Napierala.Ed
441072c68cSEdward Tomasz Napierala.Sh DESCRIPTION
451072c68cSEdward Tomasz NapieralaThe
461072c68cSEdward Tomasz Napierala.Nm
471072c68cSEdward Tomasz Napierala(iSCSI Extensions for RDMA) initiator driver extends the iSCSI protocol to RDMA.
481072c68cSEdward Tomasz NapieralaIt permits data to be transferred directly into and out of SCSI buffers
491072c68cSEdward Tomasz Napieralawithout intermediate data copies.
501072c68cSEdward Tomasz NapieralaiSER uses the RDMA protocol suite to supply higher bandwidth for
51*8cf995b3SEdward Tomasz Napieralablock storage transfers (zero copy behavior).
52*8cf995b3SEdward Tomasz NapieralaTo that fact, it eliminates the
531072c68cSEdward Tomasz NapieralaTCP/IP processing overhead while preserving the compatibility with iSCSI protocol.
541072c68cSEdward Tomasz NapieralaThe initiator is the iSCSI/iSER client, which connects to an iSCSI/iSER target,
551072c68cSEdward Tomasz Napieralaproviding local access to a remote block device.
561072c68cSEdward Tomasz NapieralaThe userland component is provided by
571072c68cSEdward Tomasz Napierala.Xr iscsid 8
581072c68cSEdward Tomasz Napieralaand both the kernel and userland are configured using
591072c68cSEdward Tomasz Napierala.Xr iscsictl 8 .
601072c68cSEdward Tomasz Napierala.Sh SYSCTL VARIABLES
611072c68cSEdward Tomasz NapieralaThe following variables are available as both
621072c68cSEdward Tomasz Napierala.Xr sysctl 8
631072c68cSEdward Tomasz Napieralavariables and
641072c68cSEdward Tomasz Napierala.Xr loader 8
651072c68cSEdward Tomasz Napieralatunables:
661072c68cSEdward Tomasz Napierala.Bl -tag -width indent
671072c68cSEdward Tomasz Napierala.It Va kern.iser.debug
681072c68cSEdward Tomasz NapieralaVerbosity level for log messages from the
691072c68cSEdward Tomasz Napierala.Nm
701072c68cSEdward Tomasz Napieraladriver.
711072c68cSEdward Tomasz NapieralaSet to 0 to disable logging or 1 to warn about potential problems.
721072c68cSEdward Tomasz NapieralaLarger values enable info and debugging output.
731072c68cSEdward Tomasz NapieralaDefaults to 0.
741072c68cSEdward Tomasz Napierala.El
751072c68cSEdward Tomasz Napierala.Sh SEE ALSO
761072c68cSEdward Tomasz Napierala.Xr iscsi 4 ,
771072c68cSEdward Tomasz Napierala.Xr iscsi.conf 5 ,
781072c68cSEdward Tomasz Napierala.Xr iscsictl 8 ,
791072c68cSEdward Tomasz Napierala.Xr iscsid 8
801072c68cSEdward Tomasz Napierala.Sh HISTORY
811072c68cSEdward Tomasz NapieralaThe
821072c68cSEdward Tomasz Napierala.Nm
831072c68cSEdward Tomasz Napieralasubsystem first appeared in
841072c68cSEdward Tomasz Napierala.Fx 11.0 .
851072c68cSEdward Tomasz Napierala.Sh AUTHORS
861072c68cSEdward Tomasz NapieralaThe
871072c68cSEdward Tomasz Napierala.Nm
881072c68cSEdward Tomasz Napieralasubsystem was developed by
891072c68cSEdward Tomasz Napierala.An Max Gurtovoy Aq Mt maxg@mellanox.com
901072c68cSEdward Tomasz Napieralaand
911072c68cSEdward Tomasz Napierala.An Sagi Grimberg Aq Mt sagig@mellanox.com
921072c68cSEdward Tomasz Napieralaunder sponsorship from Mellanox Technologies.
93